**FastAPI** 對此的支援方式與使用普通字串相同：

{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *}

## 摘要與描述 { #summary-and-description }

你可以加入 `summary` 與 `description`：

{* ../../docs_src/path_operation_configuration/tutorial003_py310.py hl[17:18] *}

## 從 docstring 取得描述 { #description-from-docstring }

由於描述常常較長、跨越多行，你可以在函式的 <dfn title="用於文件的多行字串，作為函式內的第一個運算式（不賦值給任何變數）">文件字串（docstring）</dfn> 中宣告「路徑操作」的描述，**FastAPI** 會從那裡讀取。

        }
        if (StringUtil.isNotBlank(dataConfigPager.description)) {
            if (dataConfigPager.description.startsWith("*")) {
                cb.query().setDescription_Wildcard(dataConfigPager.description);
            } else if (dataConfigPager.description.endsWith("*")) {
                cb.query().setDescription_Prefix(dataConfigPager.description.replaceAll("\\*$", StringUtil.EMPTY));
            } else {

  - type: input
    id: language
    attributes:
      label: Target Language
      description: What language do you want to translate the FastAPI docs into?
      placeholder: e.g. Latin
    validations:
      required: true
  - type: textarea
    id: additional_info
    attributes:
      label: Additional Information
      description: Any other relevant information about your translation proposal
  - type: markdown

      required: true

  - type: textarea
    attributes:
      label: Example
      description: >
        Please provide an example usage of the feature that would be different with the improvement.
      render: java
    validations:
      required: true

  - type: textarea
    attributes:
      label: Current Behavior
      description: What does the feature currently do?
    validations:
      required: true

                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "422": {
                                "description": "Validation Error",
                                "content": {

                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            },
                            "500": {
                                "description": "Internal Server Error",
                                "content": {

from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: str | None = None


items = [
    Item(name="Plumbus", description="A multi-purpose household device."),
    Item(name="Portal Gun", description="A portal opening device."),
    Item(name="Meeseeks Box", description="A box that summons a Meeseeks."),
]


app = FastAPI()

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


@app.post("/items/", summary="Create an item")
async def create_item(item: Item) -> Item:
    """
    Create an item with all the information:

    - **name**: each item must have a name
    - **description**: a long description
    - **price**: required

* `description`: `str` з коротким описом тегу. Може містити Markdown і буде показано в інтерфейсі документації.
* `externalDocs`: `dict`, який описує зовнішню документацію з такими полями:
    * `description`: `str` з коротким описом зовнішньої документації.
    * `url` (**обов'язково**): `str` з URL-адресою зовнішньої документації.

app = FastAPI()


class InternalItem(BaseModel):
    name: str
    description: str | None = None
    secret_key: str


class Item(BaseModel):
    name: str
    description: str | None = None


@app.get("/items/me", response_model=Item)
async def get_item() -> Any:
    item = InternalItem(
        name="Foo", description="A very nice Item", secret_key="supersecret"
    )
    return item
```