Module Import alias Import alias ImportFrom alias ImportFrom alias ImportFrom alias alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call NameLoad AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr Call NameLoad AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr BoolOpOr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str Call NameLoad Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad keyword Str keyword Str keyword Str Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str Str If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Str AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str Str If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Str AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad NameLoad attr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body If Call NameLoad NameLoad AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameLoad orelse If Call NameLoad NameLoad NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameLoad orelse Raise Call NameLoad For NameStore NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list decorator_list FunctionDef arguments args defaults body Return Call NameLoad keyword Str keyword Str keyword ListLoad Str decorator_list
N/A N/A types N/A flask apispec APISpec flask_apispec ResourceMeta flask_apispec.apidoc ViewConverter ResourceConverter FlaskApiSpec N/A object N/A N/A Flask-apispec extension.

    Usage:

    .. code-block:: python

        app = Flask(__name__)
        app.config.update({
            'APISPEC_SPEC': APISpec(
                title='pets',
                version='v1',
                plugins=['apispec.ext.marshmallow'],
            ),
            'APISPEC_SWAGGER_URL': '/swagger/',
        })
        docs = FlaskApiSpec(app)

        @app.route('/pet/<pet_id>')
        def get_pet(pet_id):
            return Pet.query.filter(Pet.id == pet_id).one()

        docs.register(get_pet)

    :param Flask app: App associated with API documentation
    :param APISpec spec: apispec specification associated with API documentation
     __init__ N/A N/A self app N/A N/A N/A N/A self app app N/A N/A self view_converter N/A ViewConverter N/A self app N/A N/A self resource_converter N/A ResourceConverter N/A self app N/A N/A self spec N/A N/A N/A N/A N/A self app config get APISPEC_SPEC N/A make_apispec N/A N/A N/A self add_routes N/A add_routes N/A N/A self N/A N/A N/A blueprint N/A N/A flask Blueprint flask-apispec __name__ static_folder ./static template_folder ./templates static_url_path /flask-apispec/static N/A json_url N/A N/A N/A N/A self app config get APISPEC_SWAGGER_URL /swagger/ N/A json_url N/A N/A N/A N/A blueprint add_url_rule json_url swagger-json N/A self swagger_json N/A ui_url N/A N/A N/A N/A self app config get APISPEC_SWAGGER_UI_URL /swagger-ui/ N/A ui_url N/A N/A N/A N/A blueprint add_url_rule ui_url swagger-ui N/A self swagger_ui N/A N/A N/A N/A self app register_blueprint blueprint N/A swagger_json N/A N/A self N/A N/A N/A N/A N/A flask jsonify N/A N/A N/A self spec to_dict N/A swagger_ui N/A N/A self N/A N/A N/A N/A N/A flask render_template swagger-ui.html N/A register N/A N/A self target endpoint blueprint N/A None None N/A N/A N/A isinstance target N/A types FunctionType N/A N/A paths N/A N/A N/A self view_converter convert target endpoint blueprint N/A N/A N/A isinstance target ResourceMeta N/A N/A paths N/A N/A N/A self resource_converter convert target endpoint blueprint N/A N/A N/A TypeError N/A path paths N/A N/A N/A N/A N/A self spec add_path path N/A N/A make_apispec N/A N/A N/A N/A N/A N/A APISpec title flask-apispec version v1 plugins N/A apispec.ext.marshmallow N/A