如何定下python fastapi中 Path/Query/Body 书写规范，并写入README.md

在Python FastAPI中，可以通过使用Pydantic模块来定义请求和响应模型，从而实现对Path/Query/Body的规范化书写。以下是一个简单的例子：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# 定义请求模型
class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

# 定义路由
@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.is_offer:
        item_dict.update({"discount": "10%"})
    return item_dict

在上面的代码中，我们通过继承BaseModel类来定义了一个请求模型Item，并在路由函数create_item中使用了该模型来接收请求的数据。这样就实现了对数据的规范化书写。

对于Path和Query参数，我们可以使用FastAPI的依赖注入系统来实现规范化书写。例如：

from fastapi import FastAPI, Path, Query

app = FastAPI()

# 定义路由
@app.get("/items/{item_id}")
async def read_item(item_id: int = Path(..., title="The ID of the item to get"), q: str = Query(None, title="Query string")):
    return {"item_id": item_id, "q": q}

在上面的代码中，我们通过使用Path和Query依赖注入函数来定义了Path和Query参数的规范化书写方式，并在路由函数read_item中使用了这些参数。

最后，将这些规范化书写方式记录在README.md文件中，可以帮助其他开发者更好地理解和使用你的API。例如：

## API请求参数规范

### Path参数

- 使用`Path`依赖注入函数来定义Path参数。
- 在函数签名中以参数形式传入Path参数。
- 使用`...`表示该参数是必须的，可以使用`title`参数来定义该参数在API文档中的标题。

### Query参数

- 使用`Query`依赖注入函数来定义Query参数。
- 在函数签名中以参数形式传入Query参数。
- 使用`None`表示该参数是可选的，可以使用`title`参数来定义该参数在API文档中的标题。

### Body参数

- 使用Pydantic模块定义请求和响应模型。
- 在路由函数中使用定义的模型来接收请求数据。