跳到内容

概述 - 如何 - 食谱

这里有一些指向文档其他部分的指针,用于解决一般问题或常见问题。

过滤数据 - 安全

要确保您不会返回超出应有的数据,请阅读有关 教程 - 响应模型 - 返回类型 的文档。

文档标签 - OpenAPI

要向您的 *路径操作* 添加标签,并在文档 UI 中对其进行分组,请阅读有关 教程 - 路径操作配置 - 标签 的文档。

文档摘要和描述 - OpenAPI

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

文档响应描述 - OpenAPI

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

文档弃用 *路径操作* - OpenAPI

要弃用 *路径操作*,并在文档 UI 中显示它,请阅读有关 教程 - 路径操作配置 - 弃用 的文档。

将任何数据转换为 JSON 兼容

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

OpenAPI 元数据 - 文档

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

OpenAPI 自定义 URL

要自定义 OpenAPI URL(或将其删除),请阅读有关 教程 - 元数据和文档 URL 的文档。

OpenAPI 文档 URL

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