跳到内容

常规 - 操作指南 - 配方

这里提供了一些指向文档其他部分的索引,用于解决常见或经常遇到的问题。

过滤数据 - 安全性

为了确保不会返回不应该返回的数据,请阅读 教程 - 响应模型 - 返回类型 文档。

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

为了在返回 JSON 数据时优化性能,请使用返回类型或响应模型。这样 Pydantic 将直接在 Rust 端处理序列化为 JSON 的工作,而无需经过 Python 层。更多信息请阅读 教程 - 响应模型 - 返回类型 文档。

文档标签 - OpenAPI

要为你的 路径操作 添加标签,并在文档 UI 中对它们进行分组,请阅读 教程 - 路径操作配置 - 标签 文档。

文档摘要和描述 - OpenAPI

要为你的 路径操作 添加摘要和描述,并使它们显示在文档 UI 中,请阅读 教程 - 路径操作配置 - 摘要和描述 文档。

文档响应描述 - OpenAPI

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

文档弃用 路径操作 - OpenAPI

要弃用某个 路径操作 并使其在文档 UI 中显示,请阅读 教程 - 路径操作配置 - 弃用 文档。

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

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

OpenAPI 元数据 - 文档

要向你的 OpenAPI 架构添加元数据(包括许可证、版本、联系人等),请阅读 教程 - 元数据和文档 URL 文档。

OpenAPI 自定义 URL

要自定义(或移除)OpenAPI URL,请阅读 教程 - 元数据和文档 URL 文档。

OpenAPI 文档 URL

要更新用于自动生成的文档用户界面的 URL,请阅读 教程 - 元数据和文档 URL 文档。