使用%REST.API類生成Swagger文件

在InterSystems IRIS中，%REST.API類是創建Swagger文件的基礎。通過調用GetWebRESTApplication方法，可以生成API的Swagger定義文件。具體文檔可以參考以下鏈接：

• InterSystems IRIS文檔

發布API并訪問文檔工具

首先，我們需要發布API。以下是一個示例API的鏈接：

• 示例API

通過訪問InterSystems IRIS文檔頁面，我們可以使用一個工具，該工具能夠接收API調用的輸出，并將其轉換為用戶友好的界面，用于服務的文檔和測試：

• 文檔工具鏈接

Swagger定義文件的結構

Swagger定義文件實際上是一個JSON格式的文件。在InterSystems IRIS中，它以%DynamicObject的形式提供。通過調用GetWebRESTApplication方法，可以獲取基于OpenAPI 2.0規范的定義文件。

豐富API基本信息

根據OpenAPI 2.0規范，我們可以在Swagger定義中添加或刪除信息，以豐富API的基本信息。例如，可以定義API的標題、描述、版本等內容。具體規范可以參考以下鏈接：

• OpenAPI 2.0規范

以下是一個示例定義的截圖：

預覽Swagger文檔

在預覽頁面上調用Swagger文檔時，我們可以看到以下輸出：

通過文檔頁面，我們可以看到API的具體方法，例如：

• POST方法：用于添加客戶端。
• GET方法：用于檢索列表。

以下是相關截圖：

測試API調用

Swagger文檔頁面還提供了測試API調用的功能。在頁面上可以看到一個“試試看”按鈕。點擊該按鈕后，可以直接執行API調用并查看結果。以下是操作示例：

Code-first方法的優勢

使用REST API的Code-first方法，我們可以靈活地控制API文檔的內容。這種方法允許開發者根據需求添加或刪除信息，從而確保發布的文檔內容符合實際需求。

通過本文的介紹，我們了解了如何在InterSystems IRIS中使用Swagger構建REST API，以及如何生成、預覽和測試API文檔。希望這些內容能夠幫助您更高效地開發和管理REST API。

原文鏈接: https://community.intersystems.com/post/rest-api-swagger-intersystems-iris