aiohttp-swagger3 0.1.8

validation for aiohttp swagger openAPI 3

aiohttp-swagger3

!!! Testers are needed !!!

Feel free to try this library and raise an issue if it does not work as expected, thanks!

About

Package for displaying swagger docs and optionally validating/parsing aiohttp requests using swagger specification 3.0 only.
It's marked as pre-alpha on pypi.org, but that's because I haven't decided architecture yet. However, we use it in production :)

Disable validation

Okay, just pass validate=False to SwaggerDocs/SwaggerFile class, default is True

Requirements

• python3.6+
• aiohttp>=3
• pyyaml
• attrs
• openapi-spec-validator
• strict_rfc3339

Limitations

• only application/json and application/x-www-form-urlencoded supported for now, but you can create own 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

from aiohttp import web
from aiohttp_swagger3 import SwaggerDocs

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()
    s = SwaggerDocs(app, '/docs', title="Swagger Petstore", version="1.0.0", components="components.yaml")
    s.add_routes([
        web.get("/pets/{pet_id}", get_one_pet),
    ])
    app['storage'] = {}
    web.run_app(app)

More examples

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
• allOf
• oneOf
• anyOf
• string formats: date, date-time, password, byte, binary, email, uuid, hostname, ipv4, ipv6

TODO (raise an issue if needed)

• aiohttp specific

• class based view

• METH_ANY (*) routes

• swagger specific

• cookies

• multipleOf

• not

• allowEmptyValue

• Common Parameters for All Methods of a Path (spec file only)

• readOnly, writeOnly

• more serialization methods, see: https://swagger.io/docs/specification/serialization/

• encoding

• form data serialization (array, object)

• default (array, object)