【web】Fastapi自动生成接口文档(Swagger、ReDoc )
larrino 2024-07-24 14:03:01 阅读 89
简介
FastAPI是流行的Python web框架,适用于开发高吞吐量API和微服务(直接支持异步编程)
FastAPI的优势之一:通过提供高级抽象和自动数据模型转换,简化请求数据的处理(用户不需要手动处理原始请求数据),并能根据路由和 Pydantic 模型自动生成 OpenAPI 接口文档。
Swagger UIReDoc
demo
<code>import uuid
import uvicorn
from typing import Any, Union, Optional
from typing_extensions import Literal
from fastapi import Body, FastAPI
from pydantic import (
BaseModel,
Field,
UUID4
)
app = FastAPI()
class UserIn(BaseModel):
channel: Literal[0, 1] = Field(0, title="渠道")code>
username: str = Field(..., title="用户名")code>
password: str = Field(..., title="用户密码", description="长度6-8位")code>
email: str = Field(..., title="用户邮箱地址")code>
full_name: str = Field(None, title="用户全名")code>
request_id: Optional[UUID4]
class UserOut(BaseModel):
username: str = Field(..., title="用户名")code>
email: str = Field(..., title="用户邮箱地址")code>
full_name: str = Field(None, title="用户全名")code>
request_id: Optional[UUID4]
# FastAPI will take care of filtering out all the data that is not declared in the output model (using Pydantic).
# 因此,FastAPI将负责过滤掉输出模型中未声明的所有数据(使用Pydantic)。
@app.post("/user/", response_model=UserOut)
async def create_user(
user: UserIn = Body(
examples={
"example1": {
"summary": "A short summary or description of the example",
"value": {
# example data here
"channel": 0,
"username": "Foo",
"password": "33759",
"email": "chencare@163.com",
"full_name": "xiaotao"
}
}
})
) -> UserOut:
user.request_id = uuid.uuid4()
print(user.request_id)
return user
if __name__ == '__main__':
uvicorn.run(app=app, access_log=True, port=9988)
运行后,会提示Uvicorn running on http://127.0.0.1:9988 (Press CTRL+C to quit)
在浏览器输入<code>http://127.0.0.1:9988/redoc( ReDoc),http://127.0.0.1:9988/docs
(Swagger UI )即可查看
ReDoc 页面如下:
ReDoc vs. Swagger UI
ReDoc更美观,Swagger UI更注重交互(用户直接从界面中发送请求,查看响应,这对于测试和调试 API 非常有用。)
声明
本文内容仅代表作者观点,或转载于其他网站,本站不以此文作为商业用途
如有涉及侵权,请联系本站进行删除
转载本站原创文章,请注明来源及作者。