Example-1.png...

The keys of the `dict` identify each example, and each value is another `dict`.

Each specific example `dict` in the `examples` can contain:

* `summary`: Short description for the example.
* `description`: A long description that can contain Markdown text.
* `value`: This is the actual example shown, e.g. a `dict`.

index-02-redoc-simple.png...

Example-3.png...

Example-1.jpg...

Example-2.jpg...

Example-3.jpg...

До этого поддерживалось только ключевое слово `example` с одним примером. Оно всё ещё поддерживается в OpenAPI 3.1.0, но помечено как устаревшее и не является частью стандарта JSON Schema. Поэтому рекомендуется мигрировать `example` на `examples`. 🤓

Подробнее — в конце этой страницы.

///

## Дополнительные аргументы `Field` { #field-additional-arguments }

例如，你可以用它為前端使用者介面新增中繼資料等。

///

/// info

OpenAPI 3.1.0（自 FastAPI 0.99.0 起使用）新增了對 `examples` 的支援，這是 **JSON Schema** 標準的一部分。

在那之前，只支援使用單一範例的關鍵字 `example`。OpenAPI 3.1.0 仍然支援 `example`，但它已被棄用，且不是 JSON Schema 標準的一部分。因此建議你將 `example` 遷移為 `examples`。🤓

你可以在本頁結尾閱讀更多。

///

## `Field` 其他參數 { #field-additional-arguments }

在 Pydantic 模型中使用 `Field()` 時，你也可以宣告額外的 `examples`：

index-01-swagger-ui-simple.png...