python openapi to rest(和back)框架
pyotr的Python项目详细描述
彼得
pyotr是一个python库,用于根据OpenAPI规范提供和使用restapi。它的名字是“python openapi to rest”的缩写。
该项目由两个可独立使用的独立库组成:
pyotr.server
是一个基于Starlette的框架,用于提供基于openapi的服务。它在功能上与connexion非常相似,只是它的目标是完全ASGI兼容。pyotr.client
是一个简单的http客户端,用于使用基于openapi的服务。
警告:这项工作仍在进行中,尚未准备好进行任何类型的生产。
快速启动
服务器
from pyotr.server import Application
app = Application.from_file("path/to/openapi.yaml", "path.to.endpoints.module")
客户
from pyotr.client import Client
client = Client.from_file("path/to/openapi.yaml")
result = client.some_endpoint_id("path", "variables", "query_var"="example")
为什么是彼得?
pyotr作为服务器和客户机的主要优点是它使用openapi规范来准备和验证请求和响应。
在pyotr.server
中,规范用于将请求路由到正确的端点,允许开发人员简单地实现端点函数。对于pyotr.client
,规范用于构造请求,在将请求发送到服务器之前应用用户提供的任何参数。