【web】Fastapi主动天生接口文档（Swagger、ReDoc ）

简介

FastAPI是盛行的Python web框架，适用于开发高吞吐量API和微服务（直接支持异步编程）
FastAPI的上风之一：通过提供高级抽象和主动数据模型转换，简化哀求数据的处置处罚（用户不需要手动处置处罚原始哀求数据），并能根据路由和 Pydantic 模型主动天生 OpenAPI 接口文档。

• Swagger UI
  
• ReDoc
  

demo

1. import uuid
2. import uvicorn
3. from typing import Any, Union, Optional
4. from typing_extensions import Literal
5. from fastapi import Body, FastAPI
6. from pydantic import (
7.     BaseModel,
8.     Field,
9.     UUID4
10. )
12. app = FastAPI()
15. class UserIn(BaseModel):
16.     channel: Literal[0, 1] = Field(0, title="渠道")
17.     username: str = Field(..., title="用户名")
18.     password: str = Field(..., title="用户密码", description="长度6-8位")
19.     email: str = Field(..., title="用户邮箱地址")
20.     full_name: str = Field(None, title="用户全名")
21.     request_id: Optional[UUID4]
24. class UserOut(BaseModel):
25.     username: str = Field(..., title="用户名")
26.     email: str = Field(..., title="用户邮箱地址")
27.     full_name: str = Field(None, title="用户全名")
28.     request_id: Optional[UUID4]
31. # FastAPI will take care of filtering out all the data that is not declared in the output model (using Pydantic).
32. # 因此，FastAPI将负责过滤掉输出模型中未声明的所有数据（使用Pydantic）。
34. @app.post("/user/", response_model=UserOut)
35. async def create_user(
36.         user: UserIn = Body(
37.             examples={
38.                 "example1": {
39.                     "summary": "A short summary or description of the example",
40.                     "value": {
41.                         # example data here
42.                         "channel": 0,
43.                         "username": "Foo",
44.                         "password": "33759",
45.                         "email": "chencare@163.com",
46.                         "full_name": "xiaotao"
47.                     }
48.                 }
49.             })
50. ) -> UserOut:
51.     user.request_id = uuid.uuid4()
52.     print(user.request_id)
53.     return user
56. if __name__ == '__main__':
57.     uvicorn.run(app=app, access_log=True, port=9988)

复制代码

运行后，会提示Uvicorn running on http://127.0.0.1:9988 (Press CTRL+C to quit)

在欣赏器输入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 非常有用。）

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。