跳到内容

通用 - 操作方法 - 教程

这里有几个指向文档其他部分的指针,用于通用或常见问题。

过滤数据 - 安全

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

文档标签 - OpenAPI

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

文档摘要和描述 - OpenAPI

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

文档响应描述 - OpenAPI

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

弃用一个路径操作 - OpenAPI

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

将任何数据转换为JSON兼容

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

OpenAPI 元数据 - 文档

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

OpenAPI 自定义 URL

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

OpenAPI 文档 URL

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