Skip to main content

OpenAPI 3 schema support for aiohttp.web applications.

Project description

CircleCI Latest Version Python versions BSD License Coverage Documentation

OpenAPI 3 schema support for aiohttp.web applications.

As well as bunch other utilities to build effective web applications with Python 3 & aiohttp.web.

  • Works on Python 3.6+

  • BSD licensed

  • Source, issues, and pull requests on GitHub

Quick Start

rororo relies on valid OpenAPI schema file (both JSON or YAML formats supported).

Example below, illustrates on how to handle operation hello_world from openapi.yaml schema file.

from pathlib import Path

from aiohttp import web

from rororo import openapi_context, OperationTableDef, setup_openapi


operations = OperationTableDef()


@operations.register
async def hello_world(request: web.Request) -> web.Response:
    with openapi_context(request) as context:
        name = context.parameters.query.get("name", "world")
        return web.json_response({"message": f"Hello, {name}!"})


def create_app(argv: List[str] = None) -> web.Application:
    app = web.Application()
    setup_openapi(
        app,
        Path(__file__).parent / "openapi.yaml",
        operations,
        route_prefix="/api"
    )
    return app

Check examples folder to see other examples on how to use OpenAPI 3 schemas with aiohttp.web applications.

Project details


Download files

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

Source Distribution

rororo-2.0.0a2.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

rororo-2.0.0a2-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file rororo-2.0.0a2.tar.gz.

File metadata

  • Download URL: rororo-2.0.0a2.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Linux/4.15.0-1043-aws

File hashes

Hashes for rororo-2.0.0a2.tar.gz
Algorithm Hash digest
SHA256 c969128163804c24933dddc9b7909318a6e2bdf0607b1eaf163dde23bfb1b50a
MD5 bfbe9d7374b6571a7a4b4dc8811d432b
BLAKE2b-256 1747fe1a498976598b478f6905e326581e4645096947934eb4a591a8637ed06b

See more details on using hashes here.

Provenance

File details

Details for the file rororo-2.0.0a2-py3-none-any.whl.

File metadata

  • Download URL: rororo-2.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Linux/4.15.0-1043-aws

File hashes

Hashes for rororo-2.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 acbef444b562a736ce2534346e4306136095bfe9f4cc0e2f1c39c4693954debd
MD5 23681ccb48abe75455bf436cefce9cb3
BLAKE2b-256 2942e293717c3971698e7cdd9cf1353928628296adf2e3479251bd4a4e55ff99

See more details on using hashes here.

Provenance

Supported by

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