Is there a way to add field description to FastAPI swagger schema if I use dependency system?
I see no place to add descriptions in simple example from FastAPI docs
async def common_parameters(q: str = None, skip: int = 0, limit: int = 100):
return {"q": q, "skip": skip, "limit": limit}
You can add description using Query
or Body
depends on your use case.
from typing import Optional
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/dummy")
async def dummy(q: Optional[str] = Query(None, description="My description")):
...
You can add even more metadata, see the documentation .
You can also use this
@app.get("/dummy")
async def dummy(q: Optional[str] = Query(None, )):
"""
This is my description of the API endpoint
"""
pass
The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.