Skip to main content

Build routes using swagger specification

Project description

https://github.com/aamalev/aiohttp_apiset/workflows/Tests/badge.svg Coverage Code style: ruff https://img.shields.io/pypi/v/aiohttp_apiset.svg Documentation Status https://img.shields.io/pypi/dm/aiohttp-apiset.svg Hatch project

Package to build routes and validate request using swagger specification 2.0.

Features

  • Building of the routing from specification swagger

  • Using inclusions other specifications with concatenate url

  • Optional output of the resulting specification and view embed swagger-ui

  • Advanced router with TreeResource

  • Extract specify parameters from request and validate with jsonschema

  • Serialize data as response with middleware

Usecase

Package aiohttp_apiset allows supports several strategies:

  • The foreign specification. When the specification is made and maintained by another team.

  • The specification in the code. When the fragments of specification are placed in the docstrings.

  • Mixed strategy. When routing are located in the specification files and operations are described in the docstrings.

Example

async def handler(request, pet_id):
    """
    ---
    tags: [Pet]
    description: Info about pet
    parameters:
      - name: pet_id
        in: path
        type: integer
        minimum: 0
    responses:
      200:
        description: OK
      400:
        description: Validation error
      404:
        description: Not found
    """
    pet = await db.pets.find(pet_id)

    if not pet:
        return {'status': 404, 'msg': 'Not Found'}

    return {
        'pet': pet,  # dict serialized inside jsonify
    }


def main():
    router = SwaggerRouter(
        swagger_ui='/swagger/',
        version_ui=2,
    )
    router.add_get('/pets/{pet_id}', handler=handler)

    app = web.Application(
        router=router,
        middlewares=[jsonify],
    )

    web.run_app(app)

Is now available in the swagger-ui to the address http://localhost:8080/swagger/. Available both branch swagger-ui. For use branch 3.x visit http://localhost:8080/swagger/?version=3

Examples: examples

Development

Check code:

hatch run lint:all

Format code:

hatch run lint:fmt

Run tests:

hatch run pytest

Run tests with coverage:

hatch run cov

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiohttp_apiset-0.9.18.tar.gz (11.7 MB view details)

Uploaded Source

Built Distribution

aiohttp_apiset-0.9.18-py3-none-any.whl (11.9 MB view details)

Uploaded Python 3

File details

Details for the file aiohttp_apiset-0.9.18.tar.gz.

File metadata

  • Download URL: aiohttp_apiset-0.9.18.tar.gz
  • Upload date:
  • Size: 11.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for aiohttp_apiset-0.9.18.tar.gz
Algorithm Hash digest
SHA256 9bef25674d3593d355ed418cfdbf73eb4814f46364168e0da0206e494235c032
MD5 43ed5de5d9eadb6d51ce3f28c305d8f9
BLAKE2b-256 bdfcabb9e10ce2523506e3ffd4961de08ec99ced0d81fc5ea5be662e90be7f8d

See more details on using hashes here.

File details

Details for the file aiohttp_apiset-0.9.18-py3-none-any.whl.

File metadata

File hashes

Hashes for aiohttp_apiset-0.9.18-py3-none-any.whl
Algorithm Hash digest
SHA256 bdf251e9a198d3502c703a762b45c2ad571843e29708040a6af35dc4cc2fb851
MD5 a31c6042396761010c0ab858995568f3
BLAKE2b-256 f4a08fd76addeadcc0bfe29584c69f17434c5a7dc59fb63fba2707fa3068d90e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page