how to description endpoint func's parameter

[livizy]

how can i add endpoint func's parameter description at here

[Chintan-patel-24]

In FastAPI, you can add descriptions to endpoint function parameters using the Depends or Query, Path, Header, Cookie, Body, Form, File dependencies, and their description argument, or by using Pydantic models for request bodies and adding docstrings to the model fields or using Field with a description argument.

1. Using Query, Path, Header, Cookie etc. with description:
   For individual parameters in your path operation function, you can add a description argument directly to the Query, Path, Header, or Cookie dependency:
   Python

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/items/")
async def read_items(
q: str = Query(None, description="A search query string for filtering items.")
):
return {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}], "q": q}
2. Using Pydantic Field with description for request bodies:
When defining a request body using a Pydantic model, you can add descriptions to individual fields within the model using Field and its description argument:
Python

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()

class Item(BaseModel):
name: str = Field(..., description="The name of the item.")
description: str = Field(None, description="A detailed description of the item.")
price: float = Field(..., description="The price of the item.")
tax: float = Field(None, description="The tax applied to the item.", le=1.0)

@app.post("/items/")
async def create_item(item: Item):
return item
3. Using Docstrings in Pydantic Models (for simpler cases):
For simpler descriptions, you can also use docstrings directly on the fields within your Pydantic models, although Field(description=...) offers more control and is generally preferred for explicit documentation:
Python

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
name: str
"""The name of the item."""
description: str = None
"""A detailed description of the item."""

@app.post("/items/")
async def create_item(item: Item):
return item
These descriptions will then automatically appear in the interactive API documentation (e.g., Swagger UI at /docs or ReDoc at /redoc) generated by FastAPI, making your API easier to understand and use.