一、 请求说明

1、 tags参数 - 请求分类

使用该参数，可以在生成的文档中进行分类

语法：

from typing import Set, Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None
    tags: Set[str] = set()


@app.post("/items/", response_model=Item, tags=["items"])
async def create_item(item: Item):
    return item


@app.get("/items/", tags=["items"])
async def read_items():
    return [{"name": "Foo", "price": 42}]


@app.get("/users/", tags=["users"])
async def read_users():
    return [{"username": "johndoe"}]

效果展示：

.png

2、summary参数 - 请求说明1

@app.get("/", summary="这是跟路径请求")

3、description参数 - 请求说明2

@app.get("/", summary="这是跟路径请求", description="根路径请求无需参数")

4、docstring参数

注意：如果使用这种说明方式，不能同时使用 description参数

@app.get("/", summary="这是跟路径请求")
async def read_users():
    """
    docstring： 比较长的文档说明放在这里
    :return:
    """
    return True

二、response_description - 响应说明

@app.get("/", response_description="这是响应说明")

三、deprecated - 标记弃用

使用该参数，可以让请求在文档中被标记为弃用

from fastapi import FastAPI

app = FastAPI()


@app.get("/", summary="可用路径", deprecated=False)
async def root():
    return True


@app.get("/root1", summary="弃用路径", deprecated=True)
async def root1():
    return True