通用 - 如何 - 配方¶
以下是一些指向文档中其他地方的指针,用于解决一般或常见问题。
过滤数据 - 安全性¶
为了确保不会返回超出应返回的数据,请阅读教程 - 响应模型 - 返回类型的文档。
文档标签 - OpenAPI¶
要为你的*路径操作*添加标签,并在文档UI中对其进行分组,请阅读教程 - 路径操作配置 - 标签的文档。
文档摘要和描述 - OpenAPI¶
要为你的*路径操作*添加摘要和描述,并在文档UI中显示它们,请阅读教程 - 路径操作配置 - 摘要和描述的文档。
文档响应描述 - OpenAPI¶
要定义在文档UI中显示的响应描述,请阅读教程 - 路径操作配置 - 响应描述的文档。
文档弃用*路径操作* - OpenAPI¶
要弃用一个*路径操作*,并在文档UI中显示它,请阅读教程 - 路径操作配置 - 弃用的文档。
将任何数据转换为JSON兼容¶
要将任何数据转换为JSON兼容格式,请阅读教程 - JSON兼容编码器的文档。
OpenAPI元数据 - 文档¶
要为你的OpenAPI模式添加元数据,包括许可证、版本、联系信息等,请阅读教程 - 元数据和文档URL的文档。
OpenAPI自定义URL¶
要自定义OpenAPI URL(或移除它),请阅读教程 - 元数据和文档URL的文档。
OpenAPI文档URL¶
要更新用于自动生成文档用户界面的URL,请阅读教程 - 元数据和文档URL的文档。