Python read me.md 怎么写fastapi path query body 的参数规范
时间: 2023-12-10 12:38:52 浏览: 155
在 Python 的 `readme.md` 文件中,可以使用以下格式规范说明 `fastapi` 中的路径参数、查询参数和请求体参数:
## 路径参数
使用 `{}` 包含参数名称作为路径参数,例如:
```python
@app.get("/users/{user_id}")
async def read_user(user_id: int):
return {"user_id": user_id}
```
## 查询参数
使用 `FastAPI` 中的 `Query` 类来声明查询参数,例如:
```python
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
async def read_items(skip: int = 0, limit: int = 10):
return {"skip": skip, "limit": limit}
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = Query(None, min_length=3)):
return {"item_id": item_id, "q": q}
```
## 请求体参数
使用 `FastAPI` 中的 `Body` 类来声明请求体参数,例如:
```python
from fastapi import FastAPI, Body
app = FastAPI()
@app.post("/items/")
async def create_item(item: Item):
return item
@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
return {"item_id": item_id, "item": item}
```
其中,`Item` 是一个 Pydantic 模型,用于验证和序列化请求体参数。
阅读全文