OpenAPI 规范 v3.1.0
OpenAPI 规范 v3.1.0
1. OpenAPI 规范
2. 简介
3. 定义
4. 规范
4.1 版本
4.2 格式
4.3 文档结构
4.4 数据类型
4.5 富文本格式化
4.6 URI 中的相对引用
4.7 URL 中的相对引用
4.8 模式
4.9 规范扩展
4.10 安全过滤
4.10 安全过滤
创建时间: 2025-05-29 16:38

OpenAPI规范中的一些对象可以声明并保持为空,或者完全删除,即使它们本质上是API文档的核心。

这样做的原因是为了允许对文档进行额外的访问控制层。虽然本身不是规范的一部分,但某些库可以选择根据某种形式的身份验证/授权来允许访问文档的部分内容。

以下两个示例

  1. 路径对象可以存在但为空。这可能与直觉相反,但这可能会告诉查看者他们到达了正确的位置,但无法访问任何文档。他们仍然可以访问至少信息对象,其中可能包含有关身份验证的其他信息。
  2. 路径项对象可以为空。在这种情况下,查看者将知道该路径存在,但将无法看到其任何操作或参数。这与从路径对象中隐藏路径本身不同,因为用户将知道它的存在。这允许文档提供者精细地控制查看者可以看到的内容。
最后更新: -