OpenAPI 3 schema support for aiohttp.web applications.
Project description
Implement aiohttp.web OpenAPI 3 server applications with schema first approach.
As well as bunch other utilities to build effective server applications with Python 3 & aiohttp.web.
Works on Python 3.6+
Works with aiohttp.web 3.6+
BSD licensed
Source, issues, and pull requests on GitHub
Quick Start
rororo relies on valid OpenAPI 3 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 typing import List
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:
return setup_openapi(
web.Application(),
Path(__file__).parent / "openapi.yaml",
operations,
server_url="/api",
)Schema First Approach
Unlike other popular Python OpenAPI 3 solutions, such as Django REST Framework, FastAPI, flask-apispec, or aiohttp-apispec rororo requires you to provide valid OpenAPI 3 schema first. This makes rororo similar to connexion, pyramid_openapi3 and other schema first libraries.
Class Based Views
rororo supports class based views as well. Todo-Backend example illustrates how to use class based views for OpenAPI 3 servers.
In snippet below, rororo expects that OpenAPI 3 schema contains operation ID UserView.get,
@operations.register
class UserView(web.View):
async def get(self) -> web.Response:
...More Examples
Check examples folder to see other examples on how to build aiohttp.web OpenAPI 3 server applications.
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
Built Distribution
File details
Details for the file rororo-2.0.0rc3.tar.gz.
File metadata
- Download URL: rororo-2.0.0rc3.tar.gz
- Upload date:
- Size: 34.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3c1d6cd204897f70566d08222d5c84a0e35803535ed12495407f5905d3008d3c |
|
| MD5 | 8c566678dfd3698c050e5ca3a2087b78 |
|
| BLAKE2b-256 | f252d18e5c40d60afc5a46c65f14eaeaf4e0118eead84c4c9da6adcd4c9d3589 |
Provenance
File details
Details for the file rororo-2.0.0rc3-py3-none-any.whl.
File metadata
- Download URL: rororo-2.0.0rc3-py3-none-any.whl
- Upload date:
- Size: 39.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d7fcd1282451d1eb7e8b7fe141dc0a463c7ffdf71fcd38af698281c83b5300b5 |
|
| MD5 | d67c2014136e4ab511373cae60f2d277 |
|
| BLAKE2b-256 | 10f13de079e4a4b77564bb761f307e4bc46ef15c5c69dbaf4d260985f8818dbb |
