fastapi 生成api文档

FastAPI是一个用于构建现代高性能Web API的Python框架，它支持自动API文档生成。当你使用FastAPI创建应用程序时，你可以通过注解你的路由、参数和请求体，FastAPI会在运行时自动生成详细的API文档。这个功能主要是通过`Uvicorn`服务器和第三方库`Swagger UI`配合实现的。

要在FastAPI应用中启用API文档，你需要做以下几个步骤：

1. 安装必要的依赖：首先安装`uvicorn`和`fastapi-swagger-ui`，可以使用`pip install uvicorn fastapi[docs]`

2. 使用装饰器：使用FastAPI的`APIRoute`装饰器，并在函数上添加`response_model`、`tags`等元数据，这些都是自动生成文档的关键信息。

from fastapi import APIRouter, Depends, HTTPException, status
from pydantic import BaseModel

router = APIRouter(tags=["example"])

# 示例函数
@router.get("/items/{item_id}", response_model=YourResponseModel)
async def read_item(item_id: int):
    # ...

3. 配置文档：在启动应用时，使用`app.include_router`并设置`openapi_url`和`redoc_url`来指向生成的文档。

from fastapi import FastAPI

app = FastAPI(
    title="My API",
    openapi_url="/api/v1/openapi.json",
    redoc_url="/api/v1/docs"
)

app.include_router(router)

4. 运行应用：启动`uvicorn`，访问`http://localhost:8000/docs`，就可以看到生成的API文档了。