OpenAPI Specification 3.0 支持

使用 API Designer 设计采用 OpenAPI Specification (OAS) 3.0 的 API。

OpenAPI Specification 3.0 附带了新功能，为 API 设计人员带来了更强的表现力和更高的生产力。

有关 OpenAPI 的更多信息，请参阅 Swagger 文档。

组件

组件允许您在整个 API 中重用各种元素。这些元素可以是：

组合允许您通过组合其他几个数据类型来创建新的数据类型。API Designer 支持两种类型的组合：

组合 (allOf) 允许您聚合来自不同模式的模式属性。例如，您可以通过重用现有类型 Contact 和 Error 中的所有属性来定义数据类型 Company。
多态性（oneOf/anyOf）允许您创建一个可以使用不同数据类型属性的实体。
- oneOf 允许您定义一个包含所选类型之一的属性的数据类型。例如，如果您创建一个操作来获取有关服务帐户的信息，则可以使用 oneOf 组合定义响应，以获取 Error 的所有属性或 ServiceAccountCount 的所有属性。
- anyOf 允许您定义一个包含一个或多个所选类型属性的数据类型。例如，您可以定义一个包含不同属性的数据类型 nervousSystem 和类型 skeleton，并使用 anyOf 组合创建一个包含这两种类型中任何属性的数据类型。
  只要 anyOf 组合包含至少一个所选数据类型的所有必需参数，它就是有效的。以下示例使用了 nervousSystem 类型中的 brain_weight 属性，以及 skeleton 中的 skull_height 和 teeth 属性。