contact 字段| 参数 | 类型 | 描述 |
|---|---|---|
name | str | 联系人/组织的识别名称。 |
url | str | 指向联系信息的 URL。必须采用 URL 格式。 |
email | str | 联系人/组织的电子邮件地址。必须采用电子邮件地址的格式。 |
license_info 字段| 参数 | 类型 | 描述 |
|---|---|---|
name | str | 必须（如果设置了 license_info）。用于 API 的许可证名称。 |
identifier | str | API 的 [SPDX](https://spdx.org/licenses/) 许可证表达式。字段 identifier 与字段 url 互斥。自 OpenAPI 3.1.0、FastAPI 0.99.0 起可用。 |
url | str | 用于 API 的许可证的 URL。必须采用 URL 格式。 |
## 许可证标识符 { #license-identifier }
自 OpenAPI 3.1.0 和 FastAPI 0.99.0 起，你还可以在 `license_info` 中使用 `identifier` 而不是 `url`。
例如：
{* ../../docs_src/metadata/tutorial001_1_py310.py hl[31] *}
## 标签元数据 { #metadata-for-tags }
你也可以通过参数 `openapi_tags` 为用于分组路径操作的不同标签添加额外的元数据。
它接收一个列表，列表中每个标签对应一个字典。
每个字典可以包含：
- `name`（必填）：一个 `str`，与在你的*路径操作*和 `APIRouter` 的 `tags` 参数中使用的标签名相同。
- `description`：一个 `str`，该标签的简短描述。可以使用 Markdown，并会显示在文档 UI 中。
- `externalDocs`：一个 `dict`，描述外部文档，包含：
- `description`：一个 `str`，该外部文档的简短描述。
- `url`（必填）：一个 `str`，该外部文档的 URL。
### 创建标签元数据 { #create-metadata-for-tags }
让我们在带有标签的示例中为 `users` 和 `items` 试一下。
创建标签元数据并把它传递给 `openapi_tags` 参数：
{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *}
注意你可以在描述内使用 Markdown，例如「login」会显示为粗体（**login**）以及「fancy」会显示为斜体（_fancy_）。
/// tip | 提示
不必为你使用的所有标签都添加元数据。
///
### 使用你的标签 { #use-your-tags }
将 `tags` 参数和*路径操作*（以及 `APIRouter`）一起使用，将其分配给不同的标签：
{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *}
/// note | 注意
阅读更多关于标签的信息[路径操作配置](path-operation-configuration.md#tags)。
///
### 查看文档 { #check-the-docs }
如果你现在查看文档，它们会显示所有附加的元数据：
### 标签顺序 { #order-of-tags }
每个标签元数据字典的顺序也定义了在文档用户界面显示的顺序。
例如按照字母顺序，即使 `users` 排在 `items` 之后，它也会显示在前面，因为我们将它的元数据添加为列表内的第一个字典。
## OpenAPI URL { #openapi-url }
默认情况下，OpenAPI 模式服务于 `/openapi.json`。
但是你可以通过参数 `openapi_url` 对其进行配置。
例如，将其设置为服务于 `/api/v1/openapi.json`：
{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}
如果你想完全禁用 OpenAPI 模式，可以将其设置为 `openapi_url=None`，这样也会禁用使用它的文档用户界面。
## 文档 URLs { #docs-urls }
你可以配置两个文档用户界面，包括：
- **Swagger UI**：服务于 `/docs`。
- 可以使用参数 `docs_url` 设置它的 URL。
- 可以通过设置 `docs_url=None` 禁用它。
- **ReDoc**：服务于 `/redoc`。
- 可以使用参数 `redoc_url` 设置它的 URL。
- 可以通过设置 `redoc_url=None` 禁用它。
例如，设置 Swagger UI 服务于 `/documentation` 并禁用 ReDoc：
{* ../../docs_src/metadata/tutorial003_py310.py hl[3] *}