defspec

从 dataclass、attrs、msgspec 等创建OpenAPI规范和文档。

为什么不...

[!NOTE]还有很多其他项目可以生成OpenAPI文档甚至验证数据。本项目不旨在替代它们。

本项目是私人倡议的遗产。在开发过程中，我发现使用msgspec可以优雅地定义和生成API模式。OpenAPI组件可用于为各种项目生成API文档。因此，我决定将其提取出来，并将其转换为公共项目。

当您不想引入太多其他依赖项时，可以使用此项目作为低级组件或直接模块。

安装

pip install defspec

示例

• flask: examples/flask
• falcon: examples/falcon

您可以在浏览器中打开上述示例并查看OpenAPI文档

• swagger: http://127.0.0.1:8000/openapi/swagger
• redoc: http://127.0.0.1:8000/openapi/redoc
• scalar: http://127.0.0.1:8000/openapi/scalar

用法

from dataclasses import dataclass
from typing import List

from defspec import OpenAPI


@dataclass
class User:
    name: str
    age: int


openapi = OpenAPI()
openapi.register_route("/", method="get", summary="Hello World")
openapi.register_route(
    "/users", method="post", summary="Get all the user info", response_type=List[User]
)

# get the OpenAPI spec
print(openapi.to_dict())
# get the OpenAPI spec bytes
with open("openapi.json", "wb") as f:
    f.write(openapi.to_json())

# serve as a HTTP server
openapi.serve_as_http_daemon(port=8000, run_in_background=True)