This line

https://github.com/jmcarp/flask-apispec/blob/2f8429ca8e4fa4dd9c0dee12a721f2abd36a9778/flask_apispec/apidoc.py#L70

should be removed since that parameter was removed in apispec 0.20.0: https://github.com/marshmallow-code/apispec/commit/7009b17f4bc9c390427ebf51dd45f2fe41dfef8a.

See the change I made in flask-rest-api: https://github.com/Nobatek/flask-rest-api/commit/4a239d5adfd56a865c4d4901edbd3373a86a4470.

➜ python petstore.py 
Traceback (most recent call last):
  File "petstore.py", line 73, in <module>
    docs.register(get_pet)
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/extension.py", line 121, in register
    resource_class_args, resource_class_kwargs)
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/extension.py", line 68, in _defer
    bound()
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/extension.py", line 136, in _register
    paths = self.view_converter.convert(target, endpoint, blueprint)
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 42, in convert
    return [self.get_path(rule, target, **kwargs) for rule in rules]
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 42, in <listcomp>
    return [self.get_path(rule, target, **kwargs) for rule in rules]
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 53, in get_path
    for method, view in six.iteritems(operations)
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 54, in <dictcomp>
    if method.lower() in (set(valid_methods) - {'head'})
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 66, in get_operation
    'parameters': self.get_parameters(rule, view, docs, parent),
  File "/tmp/apispectest/env/lib/python3.7/site-packages/flask_apispec/apidoc.py", line 97, in get_parameters
    extra_params += converter(schema, **options) if args else []
TypeError: fields2parameters() missing 1 required keyword-only argument: 'default_in'

pip freeze
apispec==3.0.0
Click==7.0
Flask==1.1.1
flask-apispec==0.8.3
itsdangerous==1.1.0
Jinja2==2.10.1
MarkupSafe==1.1.1
marshmallow==3.2.0
six==1.12.0
webargs==5.5.1
Werkzeug==0.16.0

halp

Summary

Register rules on Init

On calling FlaskApiSpec(app), register rules which have already been registered on app. This means that in most cases FlaskApiSpec(app) should come after calls to @app.route() and app.register_blueprint() in an app's main method

Changes to empty parameters

Also return an empty list of parameters instead of an object specifying an empty "body" object if a rule does not have a use_kwargs decorator.

From:

"parameters": [
     {
        "in": "body", 
        "name": "body", 
        "required": false, 
        "schema": {
              "type": "object"
        }
    }
]

to:

"parameters": []

Notes

I would have liked to have a register_blueprint function, but I could not for the life of me figure out how to extract the functions from a flask blueprint in the way I did with app.view_functions, so instead I opted to register all methods on app at init time.

I can also break this PR up into 2 separate PRs if you think the 2 changes should be reviewed separately.

Lastly, I am just starting to use this library in a large existing project so I may need to make more edits as I go along and discover more features I need.

The documentation page at https://flask-apispec.readthedocs.io/en/latest/ is very outdated. It indicates that the current version is 0.7.0 which was released in 2018. Since this is the first result on DuckDuckGo (second on Google) when searching for flask-apispec it should probably be updated to reflect the most recent version.

Running Quickstart guide I got the following stack trace

Traceback (most recent call last):
  File "/Users/mac_user/Library/Application Support/JetBrains/PyCharm2022.2/scratches/api_spec_sample.py", line 58, in <module>
    docs.register(PetResource)
  File "/Users/mac_user/PycharmProjects/web-app/venv/lib/python3.9/site-packages/flask_apispec/extension.py", line 127, in register
    self._defer(self._register, target, endpoint, blueprint,
  File "/Users/mac_user/PycharmProjects/web-app/venv/lib/python3.9/site-packages/flask_apispec/extension.py", line 71, in _defer
    bound()
  File "/Users/mac_user/PycharmProjects/web-app/venv/lib/python3.9/site-packages/flask_apispec/extension.py", line 147, in _register
    paths = self.resource_converter.convert(
  File "/Users/mac_user/PycharmProjects/web-app/venv/lib/python3.9/site-packages/flask_apispec/apidoc.py", line 38, in convert
    rules = self.app.url_map._rules_by_endpoint[endpoint]
KeyError: 'petresource'

Code

from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from flask import Flask, make_response
from flask_apispec import use_kwargs, marshal_with, MethodResource, FlaskApiSpec
from marshmallow import Schema


class Pet:
    def __init__(self, name, type):
        self.name = name
        self.type = type


app = Flask(__name__)


class PetSchema(Schema):
    class Meta:
        fields = ('name', 'category', 'size')


class PetResource(MethodResource):

    @marshal_with(PetSchema)
    def get(self, pet_id):
        return Pet.query.filter(Pet.id == pet_id).one()

    @use_kwargs(PetSchema)
    @marshal_with(PetSchema, code=201)
    def post(self, **kwargs):
        return Pet(**kwargs)

    @use_kwargs(PetSchema)
    @marshal_with(PetSchema)
    def put(self, pet_id, **kwargs):
        pet = Pet.query.filter(Pet.id == pet_id).one()
        pet.__dict__.update(**kwargs)
        return pet

    @marshal_with(None, code=204)
    def delete(self, pet_id):
        pet = Pet.query.filter(Pet.id == pet_id).one()
        pet.delete()
        return make_response('', 204)


app.config.update({
    'APISPEC_SPEC': APISpec(
        openapi_version='2.0',
        title='pets',
        version='v1',
        plugins=[MarshmallowPlugin()],
    ),
    'APISPEC_SWAGGER_URL': '/swagger/',
})

docs = FlaskApiSpec(app)
docs.register(PetResource)

if __name__ == "__main__":
    app.run(port=5000)

Package Version

Flask==2.2.2
flask-apispec==0.11.4
marshmallow ==3.18.0
apispec==6.0.0

When using @use_kwargs with the unknown parameter, to be able to use the unknown parameter of the schema, as described here in the webargs documentation:

class RandomSchema(Schema):
    class Meta:
        unknown = EXCLUDE

@use_kwargs(RandomSchema, location="json", unknown=None)

The following exception is raised: TypeError: schema2parameters() got an unexpected keyword argument 'unknown' Would it be possible for flask_apispec version of @use_kwargs to support this parameter? I could use the webargs version of @use_kwargs but it won't annotate the schema for swagger isn't it?

Migrate CI from deprecated travis to github actions. You just need to specify your pypi token asPYPI_API_TOKEN in the project Settings > Secrets > Actions Releases are pushed to pypi on tag creation (i think thats how it currently works?)

The workflow is completing on my local fork: https://github.com/stufisher/flask-apispec/actions/runs/2845107965

This PR contains 2 changes in FlaskApiSpec.register_existing_resources:

• Move skipping static rules to the beginning as there is no need to try splitting names if we want to continue loop
• Change name.split -> name.rsplit(..., maxsplit=1) to handle nested blueprints because they produce more than one dot in name