aiohttp-apischema 0.0.1

安装

从PyPI安装

pip install aiohttp-apischema

开发

安装要求和启动测试

pip install -r requirements-dev.txt
pytest

基本用法

首先创建一个SchemaGenerator实例

from aiohttp_apischema import SchemaGenerator
SCHEMA = SchemaGenerator()

然后装饰应包含在模式中的端点处理程序

from aiohttp_apischema import APIResponse

@SCHEMA.api()
async def foo(request: web.Request) -> APIResponse[list[str], Literal[200]]:
    return APIResponse(["foo"])

或者对于基于类的视图

@SCHEMA.api_view()
class Handler(web.View):
    async def get(self) -> APIResponse[int, Literal[200]] | APIResponse[None, Literal[404]]:
        bar_id = int(self.request.match_info["id"])
        if bar_id == 1:
            return APIResponse(42)
        return APIResponse[None, Literal[404]](None, status=404)

然后构建您的应用程序时调用设置方法

app = web.Application()
app.router.add_get("/foo", foo)
app.router.add_view(r"/bar/{id:\d+}", Handler)
SCHEMA.setup(app)

您现在可以在/swagger/路径下查看文档。

验证用法

通过添加位置参数实现请求体的验证

async def handler(request: web.Request, body: dict[int, str]) -> APIResponse[int, Literal[200]]:
    # body has been validated, so we can be sure the keys are int now.
    return APIResponse(sum(body.keys()))

许可证

aiohttp_apischema在Apache 2许可证下提供。