How to add method description in Swagger UI in PyCharm with Flask-RESTX

Question

I am using Swagger as my API tooling framework and I just found this page: https://petstore.swagger.io/ and saw how each method has a description.

For example: POST: pet/ is described by add a new Pet to the store .

I thought adding this kind of description in PyCharm, using Flask-RESTX. How can I do this? I read the specification page of RESTX, but I didn't find any useful help.

Answer 1

You should have a swagger.yml.

summary: <your description here>

Basic Structure