使用 Swagger / OpenAPI 的數據 API 產生器 REST API 檔
OpenAPI 規格是用於記錄 HTTP API 的程式設計語言無關標準。 數據 API 產生器支援 OpenAPI 標準，並能夠：
- 產生所有已啟用 REST 之運行時間組態定義實體的相關信息。
- 將資訊編譯成符合 OpenAPI 架構的格式。
- 透過可視化 UI 公開產生的 OpenAPI 架構， (Swagger) 或串行化檔案。
OpenAPI 描述檔
數據 API 產生器會使用所提供運行時間組態，以及每個已定義 REST 啟用之實體的資料庫物件元數據，來產生 OpenAPI 描述檔。 架構檔案是使用 OpenAPI.NET SDK 所提供的功能來產生。 目前，架構檔案會遵循格式化為 JSON 的 OpenAPI 規格 v3.0.1 產生。
OpenAPI 描述檔可以從路徑擷取自資料 API 產生器：
GET /{rest-path}/openapi
注意
根據預設， rest-path 此值為 api 且可設定。 如需詳細資訊，請參閱 REST 組態
SwaggerUI
Swagger UI 會使用產生的 OpenAPI 規格，提供服務相關信息的 Web 型 UI。
在 Development 模式中，數據 API 產生器可讓您從專用端點檢視產生的 OpenAPI 描述檔：
GET /swagger
“Swagger” 端點不會巢狀於 底下 rest-path ，以避免與運行時間設定實體的命名衝突。