Browse Source

🌐 Add Chinese translation for Tutorial - Schema Extra Example (#2411)

pull/2476/head
maoyibo 4 years ago
committed by GitHub
parent
commit
4236c99b7f
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 58
      docs/zh/docs/tutorial/schema-extra-example.md
  2. 1
      docs/zh/mkdocs.yml

58
docs/zh/docs/tutorial/schema-extra-example.md

@ -0,0 +1,58 @@
# 模式的额外信息 - 例子
您可以在JSON模式中定义额外的信息。
一个常见的用例是添加一个将在文档中显示的`example`。
有几种方法可以声明额外的 JSON 模式信息。
## Pydantic `schema_extra`
您可以使用 `Config``schema_extra` 为Pydantic模型声明一个示例,如<a href="https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization" class="external-link" target="_blank">Pydantic 文档:定制 Schema </a>中所述:
```Python hl_lines="15-23"
{!../../../docs_src/schema_extra_example/tutorial001.py!}
```
这些额外的信息将按原样添加到输出的JSON模式中。
## `Field` 的附加参数
`Field`, `Path`, `Query`, `Body` 和其他你之后将会看到的工厂函数,你可以为JSON 模式声明额外信息,你也可以通过给工厂函数传递其他的任意参数来给JSON 模式声明额外信息,比如增加 `example`:
```Python hl_lines="4 10-13"
{!../../../docs_src/schema_extra_example/tutorial002.py!}
```
!!! warning
请记住,传递的那些额外参数不会添加任何验证,只会添加注释,用于文档的目的。
## `Body` 额外参数
你可以通过传递额外信息给 `Field` 同样的方式操作`Path`, `Query`, `Body`等。
比如,你可以将请求体的一个 `example` 传递给 `Body`:
```Python hl_lines="21-26"
{!../../../docs_src/schema_extra_example/tutorial003.py!}
```
## 文档 UI 中的例子
使用上面的任何方法,它在 `/docs` 中看起来都是这样的:
<img src="/img/tutorial/body-fields/image01.png">
## 技术细节
关于 `example``examples`...
JSON Schema在最新的一个版本中定义了一个字段 <a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.5" class="external-link" target="_blank">`examples`</a> ,但是 OpenAPI 基于之前的一个旧版JSON Schema,并没有 `examples`.
所以 OpenAPI为了相似的目的定义了自己的 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-20" class="external-link" target="_blank">`example`</a> (使用 `example`, 而不是 `examples`), 这也是文档 UI 所使用的 (使用 Swagger UI).
所以,虽然 `example` 不是JSON Schema的一部分,但它是OpenAPI的一部分,这将被文档UI使用。
## 其他信息
同样的方法,你可以添加你自己的额外信息,这些信息将被添加到每个模型的JSON模式中,例如定制前端用户界面,等等。

1
docs/zh/mkdocs.yml

@ -61,6 +61,7 @@ nav:
- tutorial/body-multiple-params.md
- tutorial/body-fields.md
- tutorial/body-nested-models.md
- tutorial/schema-extra-example.md
- 高级用户指南:
- advanced/index.md
- advanced/path-operation-advanced-configuration.md

Loading…
Cancel
Save