搜索

4.3. 其他 OAS 规格信息

download PDF

如果您希望您的文档类似 OAS Petstore 文档,您必须创建一个与关联 Petstore swagger.json 文件类似的 Swagger-compliant 规格。您可以使用此规格开箱即用来测试 ActiveDocs。但请记住,这不是您的 API。

OAS 依赖于资源声明,它映射到通过 JSON 编码的哈希。使用 Petstore swagger.json 文件作为示例,并了解每个对象。

OAS 对象

这是 API 规格的根文档对象。它列出所有最高级别字段。

info 对象

info 对象提供有关 API 的元数据。此内容显示在 ActiveDocs 页面中。

paths 对象

paths 对象保存到单个端点的相对路径。该路径附加到 basePath 以构造完整 URL。由于访问控制列表(ACL)约束,paths 可能为空。

不是对象的参数使用原语数据类型。在 Swagger 中,原始数据类型基于 JSON-Schema Draft 4 支持的类型。还有额外的原语数据类型 文件,但 3scale 仅在 API 端点启用了 CORS 时才使用它。启用 CORS 后,上传不会通过 api-docs 网关,此网关将被拒绝。

目前,OAS 支持以下 dataTypes

  • 带有可能的格式的整数: int32 和 int64。两种格式都是有符号的。
  • 带有可能格式的数字:float 和 double。
  • 普通字符串。
  • 带有可能格式的字符串:byte、date、date-time、password 和 binary。
  • 布尔值.
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.