是否可以使用flask-RESTplus自动生成swagger元数据json？

Question

I have created an api using the python library flask-Restplus and have it's associated swagger ui being exposed to eg 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 eg 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.

Answer 1

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.

Answer 2

As an alternative to running the development server and opening the browser, here is some code to extract the Swagger specification as JSON:

from flask import Flask
from flask_restplus import Api

app = Flask(__name__)
api = Api(app)

def print_swagger_file():
    with app.app_context():
        print(json.dumps(api.__schema__, indent=4))

Answer 3

To get the swagger.json, go to the :/swagger.json you will get the swagger.json. Use this swagger.json to generate the documents . Go to https://editor.swagger.io and add ur swagger.