模式的额外信息 - 例子⚓︎

您可以在JSON模式中定义额外的信息。

一个常见的用例是添加一个将在文档中显示的example。

有几种方法可以声明额外的 JSON 模式信息。

Pydantic `schema_extra`⚓︎

您可以使用 Config 和 schema_extra 为Pydantic模型声明一个示例，如Pydantic 文档：定制 Schema 中所述:

=== "Python 3.10+"

```Python hl_lines="13-21"
{!> ../../../docs_src/schema_extra_example/tutorial001_py310.py!}
```

=== "Python 3.8+"

```Python hl_lines="15-23"
{!> ../../../docs_src/schema_extra_example/tutorial001.py!}
```

这些额外的信息将按原样添加到输出的JSON模式中。

在 Field, Path, Query, Body 和其他你之后将会看到的工厂函数，你可以为JSON 模式声明额外信息，你也可以通过给工厂函数传递其他的任意参数来给JSON 模式声明额外信息，比如增加 example:

=== "Python 3.10+"

```Python hl_lines="2  8-11"
{!> ../../../docs_src/schema_extra_example/tutorial002_py310.py!}
```

=== "Python 3.8+"

```Python hl_lines="4  10-13"
{!> ../../../docs_src/schema_extra_example/tutorial002.py!}
```

Warning

请记住，传递的那些额外参数不会添加任何验证，只会添加注释，用于文档的目的。

你可以通过传递额外信息给 Field 同样的方式操作Path, Query, Body等。

比如，你可以将请求体的一个 example 传递给 Body:

=== "Python 3.10+"

```Python hl_lines="22-27"
{!> ../../../docs_src/schema_extra_example/tutorial003_an_py310.py!}
```

=== "Python 3.9+"

```Python hl_lines="22-27"
{!> ../../../docs_src/schema_extra_example/tutorial003_an_py39.py!}
```

=== "Python 3.8+"

```Python hl_lines="23-28"
{!> ../../../docs_src/schema_extra_example/tutorial003_an.py!}
```

=== "Python 3.10+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="18-23"
{!> ../../../docs_src/schema_extra_example/tutorial003_py310.py!}
```

=== "Python 3.8+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="20-25"
{!> ../../../docs_src/schema_extra_example/tutorial003.py!}
```

使用上面的任何方法，它在 /docs 中看起来都是这样的:

关于 example 和 examples...

JSON Schema在最新的一个版本中定义了一个字段 examples ，但是 OpenAPI 基于之前的一个旧版JSON Schema，并没有 examples.

所以 OpenAPI为了相似的目的定义了自己的 example (使用 example, 而不是 examples), 这也是文档 UI 所使用的 (使用 Swagger UI).

所以，虽然 example 不是JSON Schema的一部分，但它是OpenAPI的一部分，这将被文档UI使用。

同样的方法，你可以添加你自己的额外信息，这些信息将被添加到每个模型的JSON模式中，例如定制前端用户界面，等等。

最后更新: November 25, 2023
创建日期: November 25, 2023