Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Refactor OpenAPI/Swagger aiohttp addons #5326

Merged
merged 1 commit into from
Dec 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/5326.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Refactor OpenAPI/Swagger aiohttp addons, added aio-openapi
56 changes: 34 additions & 22 deletions docs/third_party.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,40 @@ Database drivers
not drop-in replacement -- the API is different. Anyway please take
a look on it -- the driver is really incredible fast.

OpenAPI / Swagger extensions
----------------------------

Extensions bringing `OpenAPI <https://swagger.io/docs/specification/about>`_
support to aiohttp web servers.

- `aiohttp-apispec <https://github.com/maximdanilchenko/aiohttp-apispec>`_
Build and document REST APIs with ``aiohttp`` and ``apispec``.

- `aiohttp_apiset <https://github.com/aamalev/aiohttp_apiset>`_
Package to build routes using swagger specification.

- `aiohttp-pydantic <https://github.com/Maillol/aiohttp-pydantic>`_
An ``aiohttp.View`` to validate the HTTP request's body, query-string, and
headers regarding function annotations and generate OpenAPI doc. Python 3.8+
required.

- `aiohttp-swagger <https://github.com/cr0hn/aiohttp-swagger>`_
Swagger API Documentation builder for aiohttp server.

- `aiohttp-swagger3 <https://github.com/hh-h/aiohttp-swagger3>`_
Library for Swagger documentation builder and validating aiohttp requests
using swagger specification 3.0.

- `aiohttp-swaggerify <https://github.com/dchaplinsky/aiohttp_swaggerify>`_
Library to automatically generate swagger2.0 definition for aiohttp endpoints.

- `aio-openapi <https://github.com/quantmind/aio-openapi>`_
Asynchronous web middleware for aiohttp and serving Rest APIs with OpenAPI v3
specification and with optional PostgreSql database bindings.

- `rororo <https://github.com/playpauseandstop/rororo>`_
Implement ``aiohttp.web`` OpenAPI 3 server applications with schema first
approach. Python 3.6+ required.

Others
------
Expand Down Expand Up @@ -127,21 +161,9 @@ period ask to raise the status.
- `gain <https://github.com/gaojiuli/gain>`_ Web crawling framework
based on asyncio for everyone.

- `aiohttp-swagger <https://github.com/cr0hn/aiohttp-swagger>`_
Swagger API Documentation builder for aiohttp server.

- `aiohttp-swagger3 <https://github.com/hh-h/aiohttp-swagger3>`_
Library for Swagger documentation builder and validating aiohttp requests using swagger specification 3.0.

- `aiohttp-swaggerify <https://github.com/dchaplinsky/aiohttp_swaggerify>`_
Library to automatically generate swagger2.0 definition for aiohttp endpoints.

- `aiohttp-validate <https://github.com/dchaplinsky/aiohttp_validate>`_
Simple library that helps you validate your API endpoints requests/responses with json schema.

- `aiohttp-pydantic <https://github.com/Maillol/aiohttp-pydantic>`_
An ``aiohttp.View`` to validate the HTTP request's body, query-string, and headers regarding function annotations and generate Open API doc. Python 3.8+ required.

- `raven-aiohttp <https://github.com/getsentry/raven-aiohttp>`_ An
aiohttp transport for raven-python (Sentry client).

Expand All @@ -164,9 +186,6 @@ period ask to raise the status.
<https://github.com/toumorokoshi/aiohttp-transmute>`_ A transmute
implementation for aiohttp.

- `aiohttp_apiset <https://github.com/aamalev/aiohttp_apiset>`_
Package to build routes using swagger specification.

- `aiohttp-login <https://github.com/imbolc/aiohttp-login>`_
Registration and authorization (including social) for aiohttp
applications.
Expand Down Expand Up @@ -245,9 +264,6 @@ period ask to raise the status.
- `GINO <https://github.com/fantix/gino>`_
An asyncio ORM on top of SQLAlchemy core, delivered with an aiohttp extension.

- `aiohttp-apispec <https://github.com/maximdanilchenko/aiohttp-apispec>`_
Build and document REST APIs with ``aiohttp`` and ``apispec``.

- `eider-py <https://github.com/eider-rpc/eider-py>`_ Python implementation of
the `Eider RPC protocol <http://eider.readthedocs.io/>`_.

Expand All @@ -264,10 +280,6 @@ period ask to raise the status.
- `DBGR <https://github.com/JakubTesarek/dbgr>`_
Terminal based tool to test and debug HTTP APIs with ``aiohttp``.

- `rororo <https://github.com/playpauseandstop/rororo>`_
Implement ``aiohtp.web`` OpenAPI 3 server applications with schema first
approach. Python 3.6+ required.

- `aiohttp-middlewares <https://github.com/playpauseandstop/aiohttp-middlewares>`_
Collection of useful middlewares for ``aiohttp.web`` applications. Python
3.6+ required.
Expand Down