fastapi/docs/zh/docs/how-to/general.md

2.6 KiB
Raw Blame History

通用 - 如何操作 - 诀窍

这里是一些指向文档中其他部分的链接,用于解答一般性或常见问题。

数据过滤 - 安全性

为确保不返回超过需要的数据,请阅读 教程 - 响应模型 - 返回类型 文档。

优化响应性能 - 响应模型 - 返回类型

在返回 JSON 数据时优化性能,请使用返回类型或响应模型,这样 Pydantic 会在 Rust 侧处理到 JSON 的序列化,而无需经过 Python。更多内容请阅读 教程 - 响应模型 - 返回类型 文档。

文档的标签 - OpenAPI

在文档界面中添加路径操作的标签和进行分组,请阅读 教程 - 路径操作配置 - Tags 文档。

文档的概要和描述 - OpenAPI

在文档界面中添加路径操作的概要和描述,请阅读 教程 - 路径操作配置 - Summary 和 Description 文档。

文档的响应描述 - OpenAPI

在文档界面中定义并显示响应描述,请阅读 教程 - 路径操作配置 - 响应描述 文档。

文档弃用路径操作 - OpenAPI

在文档界面中显示弃用的路径操作,请阅读 教程 - 路径操作配置 - 弃用 文档。

将任何数据转换为 JSON 兼容格式

要将任何数据转换为 JSON 兼容格式,请阅读 教程 - JSON 兼容编码器 文档。

OpenAPI 元数据 - 文档

要添加 OpenAPI 的元数据,包括许可证、版本、联系方式等,请阅读 教程 - 元数据和文档 URL 文档。

OpenAPI 自定义 URL

要自定义 OpenAPI 的 URL或删除它请阅读 教程 - 元数据和文档 URL 文档。

OpenAPI 文档 URL

要更改自动生成的文档用户界面所使用的 URL请阅读 教程 - 元数据和文档 URL