Swagger Python Flask

Swagger @Api Description Is Deprecated .

Swagger is a web-based API documentation framework . It is used to create interactive documents for APIs which are built to serve a specific purpose. Swagger UI documents enjoy many advantages when compared to other document types: It’s open-source. Enable you to create and share API documentation.

Although the terms once referred to the same thing, they can no longer be used interchangeably …even though some people still do. In 2021, OpenAPI refers to the industry-standard specification for RESTful API design. Swagger refers to a set of SmartBear tools.

What is flask-restful-swagger? flask-restful-swagger is a wrapper for flask-restful which enables swagger support . In essence, you just need to wrap the Api instance and add a few python decorators to get full swagger support.

Use Swagger UI to generate interactive API documentation that lets your users try out the API calls directly in the browser . Use the spec to connect API-related tools to your API. For example, import the spec to SoapUI to create automated tests for your API.

Flask-swagger provides a method (swagger) that inspects the Flask app for endpoints that contain YAML docstrings with Swagger 2.0 Operation objects .

So this is the way I managed to do it.