Automated Swagger API Doc with Flask Restful
Note: For non-members, this article is also available at https://progressstory.com/tech/python/swagger-api-doc-automation-with-flask-restful/
Before diving into the blog, let's clear the air and talk about some of the terms that we are going to use in the blog extensively.
What is Flask Restful?
Flask-RESTful is an extension for Flask that adds support for quickly building REST APIs. Flask-RESTful encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTful should be easy to pick up.
What is API Documentation?
API documentation is a technical instruction about how to effectively use an API. It’s a concise reference manual containing all the information required to work with the API like the URI, request parameters, functions, classes, return types, arguments and more, supported by tutorials and examples. API Documentation has traditionally been done using regular content creation and maintenance tools and text editors.
Something like this
