建立 REST API 定義檔

您可以使用精靈來產生 swagger.json 範本檔,以指定「代表性狀態傳輸 (REST)」應用程式設計介面 (API)。以 Liberty 伺服器為目標且使用 Web 2.5 及更高版本的專案可使用此精靈。

關於這項作業

重要: 適用於 Liberty、Liberty Core

程序

  1. 建立以 Liberty 伺服器為目標的 Web 專案。

    如需建立 Web 專案的相關資訊,請參閱建立 Web 專案。

  2. 如果要建立 Swagger REST API 定義檔,請完成下列其中一個選項:
    • 選取檔案 > 新建 > 其他,然後在「REST API 定義」區段中選取 Swagger REST API 定義檔。
    • 用滑鼠右鍵按一下專案,然後選取新建 > Swagger REST API 定義檔。
  3. 選取您想建立之「JavaScript 物件表示法 (JSON)」檔案的類型:
    • 如果要建立一個包含所有必要的最上層 Swagger 元素的檔案,請選取建立 swagger.json 範本檔。
    • 如果要建立一個包含一般定義範例內容的檔案,例如 GET、PUT 及 POST,請選取建立 swagger.json 範例檔。
  4. 選取您想建立之檔案的位置:
    • 如果要使用 Swagger 註釋,請選取產生為摘要文件(META-INF/stub 目錄)。
    • 如果您沒有使用 Swagger 註釋,請選取產生為最上層文件(META-INF 目錄)。
      註: 依預設,會選取此選項。
  5. 按一下完成。

結果

工具會在 Web 專案的 WebContent/META-INF 資料夾中產生 swagger.json 檔。此檔案會在預設 JSON 編輯器中開啟。

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html