Eve-Swagger

Swagger extension for Eve powered RESTful APIs.

Usage

from eve import Eve
from eve_swagger import get_swagger_blueprint, add_documentation

app = Eve()
swagger = get_swagger_blueprint()
app.register_blueprint(swagger)

# required. See http://swagger.io/specification/#infoObject for details.
app.config['SWAGGER_INFO'] = {
    'title': 'My Supercool API',
    'version': '1.0',
    'description': 'an API description',
    'termsOfService': 'my terms of service',
    'contact': {
        'name': 'nicola',
        'url': 'http://nicolaiarocci.com'
    },
    'license': {
        'name': 'BSD',
        'url': 'https://github.com/pyeve/eve-swagger/blob/master/LICENSE',
    },
    'schemes': ['http', 'https'],
}

# optional. Will use flask.request.host if missing.
app.config['SWAGGER_HOST'] = 'https://myhost.com'

# optional. Add/Update elements in the documentation at run-time without deleting subtrees.
add_documentation(swagger, {'paths': {'/status': {'get': {'parameters': [
    {
        'in': 'query',
        'name': 'foobar',
        'required': False,
        'description': 'special query parameter',
        'type': 'string'
    }]
}}}})

if __name__ == '__main__':
    app.run()

When the API is up and running, visit the /api-docs endpoint. The resulting JSON can then be used with swagger tooling, like the Swagger UI or Swagger Editor:

If you get the error "Can't read from server. It may not have the appropriate access-control-origin settings" from Swagger UI, you might want to enable CORS support with the X_DOMAINS and X_HEADERS configuration in your Eve settings.py:

X_DOMAINS = ['http://localhost:8000',  # The domain where Swagger UI is running
             'http://editor.swagger.io',
             'http://petstore.swagger.io']
X_HEADERS = ['Content-Type', 'If-Match', 'Authorization']  # Needed for the "Try it out" buttons

For more information check the CORS documentation of Swagger UI and Swagger Editor.

Installation

$ pip install eve-swagger

Description fields on the swagger docs

If you would like to include description fields to your swagger docs you can include a description field in your schema validations in your settings.py. This can be done per field as well as on the resource-level.

As an example:

...
'description': 'Description of the user resource',
'schema': {
    'userName': {
        'description': 'The username of the logged in user.',
        'type': 'string',
        'minlength': 1,
        'maxlength': 256,
        'required': True
    },
}
...

NOTE: If you do use this feature, you also need to provide a custom validator

to the Eve instance, otherwise you will get complaints from the Cerberus library about "unknown rule 'description' for field [yourFieldName]"

from eve.io.mongo import Validator

class MyValidator(Validator):
    def _validate_description(self, description, field, value):
        """ {'type': 'string'} """
        # Accept description attribute, used for swagger doc generation
        pass

    def _validate_example(self, description, field, value):
        """ {'type': 'string'} """
        # Accept an example attribute, used for swagger doc generation
        pass

app = Eve(validator=MyValidator)

NOTE: Swagger 2.0 may show errors about example attribute ("should NOT have additional properties").

You can disable generating example attribute by specifying in the app.py:

...
app.config['SWAGGER_EXAMPLE_FIELD_REMOVE'] = True
...

Disabling the documentation of a resource

You can disable the documentation of a specific resource by adding a disable_documentation field to the resource definition in settings.py. This means that the resource will not show up in the paths or definitions sections of the swagger docs.

...
'person': {
    'item_title': 'person',
    'disable_documentation': True,
    'schema': {...}
}
...

Enabling the documentation of Eve event hooks

By setting app.config['ENABLE_HOOK_DESCRIPTION'] to True you can enable the description of all Eve event hooks. This is done by showing the docstrings of the callback functions in the swagger docs under the appropriate paths.

def foo(request, lookup):
    """ Do something before GETting all the people """
    pass
def bar(response):
    """ Do something when you've fetched the database entries """
    pass
...
app.config['ENABLE_HOOK_DESCRIPTION'] = True
...
app.on_pre_GET_people += foo
app.on_fetched_resource_people += bar

The swagger docs will now look like this:

"paths": {
    "/people": {
        "get": {
            ...,
            "description": "**Hooks**:\n* `on_pre_GET_people`:\n\n  * `foo`:\n\n    Do something before GETting all the people\n\n\n* `on_fetched_resource_people`:\n\n  * `bar`:\n\n    Do something when you've fetched the database entries\n\n"
        }
    }
}

Which will be rendered by Swagger like this:

Example fields on the docs

Like a description, an example can be added to a field.

...
'schema': {
    'lastName': {
        'example': 'Doe',
        'type': 'string',
        'minlength': 1,
    },
}
...

The example is shown in the swagger ui in the model and the responses.

NOTE: If you do use this feature, you also need to provide a custom validator to the Eve instance, otherwise you will get complaints from the Cerberus library about "unknown rule 'example' for field [yourFieldName]" (see the above example for the 'description' option.)

from eve.io.mongo import Validator

class MyValidator(Validator):
    def _validate_example(self, example, field, value):
        if example and not isinstance(value, str):
            self._error(field, "Value must be a string")

...

app = Eve(validator=MyValidator)

Example resources on the docs

Like a description, an example can be added to a resource.

...
'sub_resource': {
    'description': 'A sub resource to test regex urls.',
    'url': 'people/<regex("[a-f0-9]{24}"):personid>/related',
    'example': {'subject': 'A sub_resource object example'},

    'schema': {
        'personid': {
            'type': 'objectid',
            'data_relation': {
                'resource': 'people',
                'field': '_id', },
        },
        'subject': {'type': 'string'},
    }
},
...

The resource example overrides the example generated from the schema definition, and can be used to hide fields that are defined on the server side. The example is shown in the swagger ui in the parameters only.

Copyright

Eve-Swagger is an open source project by Nicola Iarocci. See the original LICENSE for more information.