通用 - 如何实现 - 技巧¶
这里有指向文档中其他部分的几个提示,用于回答一般性或常见问题。
过滤数据 - 安全¶
为确保您不会返回超出所需的数据,请阅读 教程 - 响应模型 - 返回类型 的文档。
文档标签 - OpenAPI¶
要在您的 *路径操作* 中添加标签,并在文档 UI 中对它们进行分组,请阅读 教程 - 路径操作配置 - 标签 的文档。
文档摘要和描述 - OpenAPI¶
要在您的 *路径操作* 中添加摘要和描述,并在文档 UI 中显示它们,请阅读 教程 - 路径操作配置 - 摘要和描述 的文档。
文档响应描述 - OpenAPI¶
要定义响应的描述(显示在文档 UI 中),请阅读 教程 - 路径操作配置 - 响应描述 的文档。
文档废弃一个 路径操作 - OpenAPI¶
要废弃一个 *路径操作*,并在文档 UI 中显示它,请阅读 教程 - 路径操作配置 - 废弃 的文档。
将任意数据转换为 JSON 兼容格式¶
要将任意数据转换为 JSON 兼容格式,请阅读 教程 - JSON 兼容编码器 的文档。
OpenAPI 元数据 - 文档¶
要将元数据添加到您的 OpenAPI 模式中,包括许可证、版本、联系方式等,请阅读 教程 - 元数据和文档 URL 的文档。
OpenAPI 自定义 URL¶
要自定义 OpenAPI URL(或将其删除),请阅读 教程 - 元数据和文档 URL 的文档。
OpenAPI 文档 URL¶
要更新用于自动生成文档用户界面的 URL,请阅读 教程 - 元数据和文档 URL 的文档。