Search code examples
pythonjsonswaggerswashbuckleflask-restplus

is it possible to generate swagger metadata json automatically with flask-RESTplus?


I have created an api using the python library flask-Restplus and have it's associated swagger ui being exposed to e.g http://serverURL:80/api/v1/documentation.

Is it possible to expose this documentation page as a json somehow? I know this is possible using the .Net library "Swashbuckle" (for e.g http://serverURL:80/api/v1/documentation.json would return the documentation in json format). I am looking for a way for this same type of functionality in python.


Solution

  • It turns out that this .json of the swagger ui is not generated in the documentation page but rather automatically generated the root directory with flask_Restplus library. for example "http://serverURL:80/api/v1/swagger.json" was the url which had this page instead of my documentation url "http://serverURL:80/api/v1/documentation". I didn't have to make any code changes for this to work.