OpenAPI 規範 3.0 支援

使用 API Designer 設計採用 OpenAPI 規範 (OAS) 3.0 的 API。

OpenAPI 規範 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 屬性。