Blueprint definitions

Hi,

I’m creating an app with many blueprints for different sections of the API. It seems there should be a way to define definitions inside the blueprint. Something like:

blp = Blueprint(
    'pets', 'pets', url_prefix='/pets',
    description='Operations on pets'
)

@blp.definition('Pet')
class PetSchema(ma.Schema):

    class Meta:
        strict = True
        ordered = True

    id = ma.fields.Int(dump_only=True)
    name = ma.fields.String()

It’s not suitable to create a circular dependency where the API is defined so it seems you need to do something like:

api=Api()
@api.definition('Pet')

Any recommendations on workarounds? thanks!

[lafrech]

We realized today that thanks to the schema auto-registration feature introduced in apispec 1.0, there is actually no need to register the schema manually.

In other words, you can remove the call to definition everywhere

@api.definition('Pet')

and the schemas will be registered automatically anyway.

The default behaviour in apispec is to register PetSchema as Schema. This is based on the assumption that people call their schemas with the name of the model suffixed with "Schema". This behaviour can be changed for specific needs but I think it is a reasonable convention.

@qcho, can you please try to remove all calls to the definition decorator and tell me if it works?

[lafrech]

Closing this. I think this is not an issue anymore thanks to apispec auto-registration feature.

Feel free to comment if it is still an issue.