1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
|
===============
aiohttp-apispec
===============
.. image:: https://badge.fury.io/py/aiohttp-apispec.svg
:target: https://pypi.python.org/pypi/aiohttp-apispec
.. image:: https://travis-ci.org/maximdanilchenko/aiohttp-apispec.svg
:target: https://travis-ci.org/maximdanilchenko/aiohttp-apispec
.. image:: https://codecov.io/gh/maximdanilchenko/aiohttp-apispec/branch/master/graph/badge.svg
:target: https://codecov.io/gh/maximdanilchenko/aiohttp-apispec
Build and document REST APIs with aiohttp and apispec
``aiohttp-apispec`` key features:
- ``docs``, ``request_schema``, ``match_info_schema``, ``querystring_schema``, ``form_schema``, ``json_schema``, ``headers_schema``, ``cookies_schema``, decorators to add swagger spec support out of the box;
- ``validation_middleware`` middleware to enable validating with marshmallow schemas from those decorators;
- **SwaggerUI** support.
``aiohttp-apispec`` api is fully inspired by ``flask-apispec`` library
Guide
-----
.. toctree::
:maxdepth: 2
:caption: Contents:
usage
install
api
|