通用指南 - 如何操作 - 配方¶
以下是针对通用或常见问题的文档指引。
数据过滤 - 安全性¶
为确保不返回超出权限范围的数据,请阅读文档:教程 - 响应模型 - 返回类型。
文档标签 - OpenAPI¶
如需为路径操作添加标签并在文档界面中进行分组,请阅读文档:教程 - 路径操作配置 - 标签。
文档摘要与描述 - OpenAPI¶
如需为路径操作添加摘要和描述并在文档界面中展示,请阅读文档:教程 - 路径操作配置 - 摘要与描述。
文档响应描述 - OpenAPI¶
如需定义响应描述(显示在文档界面中),请阅读文档:教程 - 路径操作配置 - 响应描述。
文档弃用路径操作 - OpenAPI¶
如需弃用某个路径操作并在文档界面中标注,请阅读文档:教程 - 路径操作配置 - 弃用标记。
将任意数据转换为JSON兼容格式¶
如需将任意数据转换为JSON兼容格式,请阅读文档:教程 - JSON兼容编码器。
OpenAPI元数据 - 文档¶
如需向OpenAPI模式添加元数据(包括许可证、版本、联系方式等),请阅读文档:教程 - 元数据与文档URL。
OpenAPI自定义URL¶
如需自定义OpenAPI URL(或移除它),请阅读文档:教程 - 元数据与文档URL。
OpenAPI文档URL¶
如需更新自动生成的文档用户界面的URL,请阅读文档:教程 - 元数据与文档URL。