From 19170e4fad0cf304c43428ce7a0deb27cf6c8447 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9A=D0=BE=D1=80=D0=B5=D0=BD=D0=B1=D0=B5=D1=80=D0=B3=20?= =?UTF-8?q?=D0=9C=D0=B0=D1=80=D0=BA?= Date: Tue, 15 Dec 2020 16:59:28 +0500 Subject: [PATCH] doc: added OpenAPI/Swagger section, added aio-openapi (#5326) --- CHANGES/5326.doc | 1 + docs/third_party.rst | 56 +++++++++++++++++++++++++++----------------- 2 files changed, 35 insertions(+), 22 deletions(-) create mode 100644 CHANGES/5326.doc diff --git a/CHANGES/5326.doc b/CHANGES/5326.doc new file mode 100644 index 00000000000..74aff4c4225 --- /dev/null +++ b/CHANGES/5326.doc @@ -0,0 +1 @@ +Refactor OpenAPI/Swagger aiohttp addons, added aio-openapi diff --git a/docs/third_party.rst b/docs/third_party.rst index b4d87b84459..48821d41c84 100644 --- a/docs/third_party.rst +++ b/docs/third_party.rst @@ -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 `_ +support to aiohttp web servers. + +- `aiohttp-apispec `_ + Build and document REST APIs with ``aiohttp`` and ``apispec``. + +- `aiohttp_apiset `_ + Package to build routes using swagger specification. + +- `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 `_ + Swagger API Documentation builder for aiohttp server. + +- `aiohttp-swagger3 `_ + Library for Swagger documentation builder and validating aiohttp requests + using swagger specification 3.0. + +- `aiohttp-swaggerify `_ + Library to automatically generate swagger2.0 definition for aiohttp endpoints. + +- `aio-openapi `_ + Asynchronous web middleware for aiohttp and serving Rest APIs with OpenAPI v3 + specification and with optional PostgreSql database bindings. + +- `rororo `_ + Implement ``aiohttp.web`` OpenAPI 3 server applications with schema first + approach. Python 3.6+ required. Others ------ @@ -127,21 +161,9 @@ period ask to raise the status. - `gain `_ Web crawling framework based on asyncio for everyone. -- `aiohttp-swagger `_ - Swagger API Documentation builder for aiohttp server. - -- `aiohttp-swagger3 `_ - Library for Swagger documentation builder and validating aiohttp requests using swagger specification 3.0. - -- `aiohttp-swaggerify `_ - Library to automatically generate swagger2.0 definition for aiohttp endpoints. - - `aiohttp-validate `_ Simple library that helps you validate your API endpoints requests/responses with json schema. -- `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 `_ An aiohttp transport for raven-python (Sentry client). @@ -164,9 +186,6 @@ period ask to raise the status. `_ A transmute implementation for aiohttp. -- `aiohttp_apiset `_ - Package to build routes using swagger specification. - - `aiohttp-login `_ Registration and authorization (including social) for aiohttp applications. @@ -245,9 +264,6 @@ period ask to raise the status. - `GINO `_ An asyncio ORM on top of SQLAlchemy core, delivered with an aiohttp extension. -- `aiohttp-apispec `_ - Build and document REST APIs with ``aiohttp`` and ``apispec``. - - `eider-py `_ Python implementation of the `Eider RPC protocol `_. @@ -264,10 +280,6 @@ period ask to raise the status. - `DBGR `_ Terminal based tool to test and debug HTTP APIs with ``aiohttp``. -- `rororo `_ - Implement ``aiohtp.web`` OpenAPI 3 server applications with schema first - approach. Python 3.6+ required. - - `aiohttp-middlewares `_ Collection of useful middlewares for ``aiohttp.web`` applications. Python 3.6+ required.