aiohttp-swagger3

aiohttp-swagger3

.. image:: https://github.com/hh-h/aiohttp-swagger3/actions/workflows/ci.yaml/badge.svg?branch=master :target: https://github.com/hh-h/aiohttp-swagger3/actions .. image:: https://img.shields.io/codecov/c/github/hh-h/aiohttp-swagger3/master.svg?style=flat :target: https://codecov.io/github/hh-h/aiohttp-swagger3?branch=master .. image:: https://badge.fury.io/py/aiohttp-swagger3.svg :target: https://badge.fury.io/py/aiohttp-swagger3 .. image:: https://img.shields.io/badge/python-3.7%2B-brightgreen.svg :target: https://img.shields.io/badge/python-3.7%2B-brightgreen.svg .. image:: https://img.shields.io/badge/code%20style-black-black.svg :target: https://github.com/ambv/black .. image:: https://img.shields.io/pypi/l/aiohttp-swagger3.svg :target: https://www.apache.org/licenses/LICENSE-2.0

About

Package for displaying swagger docs via different UI backends and optionally validating/parsing aiohttp requests using swagger specification 3.0, known as OpenAPI3.

Supported UI backends

Multiple UI backends can be used or UI backend can be disabled at all if only needed validation without being able to view documentation.

• Swagger UI - https://github.com/swagger-api/swagger-ui
• ReDoc - https://github.com/Redocly/redoc
• RapiDoc - https://github.com/mrin9/RapiDoc

Documentation

https://aiohttp-swagger3.readthedocs.io/en/latest/

Disable validation

| Pass validate=False to SwaggerDocs/SwaggerFile class, the default is True | Also, sometimes validation has to be disabled for a route, to do this you have to pass validate=False during the initialization of the route. | ex. web.post("/route", handler, validate=False), the default is True

Requirements

• python >= 3.9
• aiohttp >= 3.8.0
• pyyaml >= 5.4
• attrs >= 19.3.0
• python-fastjsonschema >= 2.15.0
• rfc3339-validator >= 0.1.4

Limitations

• only application/json and application/x-www-form-urlencoded supported for now, but you can create own handler <https://github.com/hh-h/aiohttp-swagger3/tree/master/examples/custom_handler>__
• header/query parameters only supported simple/form array serialization, e.g. 1,2,3,4
• see TODO below

Installation

pip install aiohttp-swagger3

Example

.. code:: python

from aiohttp import web
from aiohttp_swagger3 import SwaggerDocs, SwaggerInfo, SwaggerUiSettings

async def get_one_pet(request: web.Request, pet_id: int) -> web.Response:
    """
    Optional route description
    ---
    summary: Info for a specific pet
    tags:
      - pets
    parameters:
      - name: pet_id
        in: path
        required: true
        description: The id of the pet to retrieve
        schema:
          type: integer
          format: int32
    responses:
      '200':
        description: Expected response to a valid request
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Pet"
    """
    if pet_id not in request.app['storage']:
        raise web.HTTPNotFound()
    return web.json_response(request.app['storage'][pet_id])

def main():
    app = web.Application()
    swagger = SwaggerDocs(
        app,
        swagger_ui_settings=SwaggerUiSettings(path="/docs/"),
        info=SwaggerInfo(
            title="Swagger Petstore",
            version="1.0.0",
        ),
        components="components.yaml"
    )
    swagger.add_routes([
        web.get("/pets/{pet_id}", get_one_pet),
    ])
    app['storage'] = {}
    web.run_app(app)

More examples <https://github.com/hh-h/aiohttp-swagger3/tree/master/examples>_

How it helps

.. image:: https://raw.githubusercontent.com/hh-h/aiohttp-swagger3/master/docs/_static/comparison.png

Features

• application/json
• application/x-www-form-urlencoded (except array and object)
• items
• properties
• pattern
• required
• enum
• minimum, maximum
• exclusiveMinimum, exclusiveMaximum
• minLength, maxLength
• minItems, maxItems
• uniqueItems
• minProperties, maxProperties
• default (only primitives)
• additionalProperties
• nullable
• readOnly
• allOf, oneOf, anyOf
• string formats: date, date-time, byte, email, uuid, hostname, ipv4, ipv6
• custom string format validators

TODO (raise an issue if needed)

• multipleOf
• not
• allowEmptyValue
• Common Parameters for All Methods of a Path (spec file only)
• more serialization methods, see: https://swagger.io/docs/specification/serialization/
• encoding
• form data serialization (array, object)
• default (array, object)