資料 API 產生器中的 OpenAPI

OpenAPI 規格是用於記錄 HTTP API 的與語言無關的標準。 資料 API 產生器透過下列方式支援 OpenAPI：

• 為執行時期配置中定義的所有已啟用 REST 的實體產生 meta 資料
• 將該中繼資料編譯為有效的 OpenAPI 結構描述
• 透過視覺化 UI （Swagger） 或序列化 JSON 檔案公開結構描述

OpenAPI 描述檔

資料 API 產生器會使用每個已啟用 REST 實體的執行階段組態和資料庫中繼資料來產生 OpenAPI 描述文件。

結構描述是使用 OpenAPI.NET SDK 建置，並符合 OpenAPI 規格 v3.0.1。 它會輸出為 JSON 文件。

您可以從以下位置存取 OpenAPI 文件：

GET /{rest-path}/openapi

[!NOTE] 預設情況下，是 rest-pathapi。 此值是可配置的。 如需詳細資訊，請參閱 REST 組態 。

Swagger 使用者介面

Swagger UI 提供基於 OpenAPI 結構描述的 API 的互動式 Web 型檢視。

在Development模式中，資料 API 產生器會公開 Swagger UI 在：

GET /swagger

此端點不會巢狀在 下 rest-path ，以避免與使用者定義的實體發生衝突。