建立 OpenAPI 規格

您正在查看 Apigee Edge 說明文件。
參閱 Apigee X說明文件。 資訊

在本教學課程中，您將建立 OpenAPI 規格，以模擬呼叫目標伺服器的 API。目標伺服器包含您在電腦上建立及執行的簡易 Node.js 伺服器。本教學課程大約需要 10 分鐘才能完成。

課程內容

在本教學課程中，您將學習如何：

軟硬體需求

以下是開始使用前需要準備的項目：

建立簡易的 Node.js 伺服器

如要建立簡易型 Node.js 伺服器，請執行下列操作：

  1. 建立名為 index.js 的檔案。

  2. 將下列 Node.js 程式碼複製到檔案中：

    var express = require('express');
var app = express();  

app.get('/v1/hello', function (req, res) {
  res.setHeader("Access-Control-Allow-Origin", "*");
  res.send('Hello World!\n');
});  

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');
});

  3. 儲存檔案。

  4. 安裝必要的 Express 模組：

    npm install express

  5. 啟動伺服器：

    node index.js

    系統會傳回下列訊息：
    Example app listening on port 3000

  6. 傳送下列 HTTP 要求來測試 API。

    curl localhost:3000/v1/hello

    API 會傳回「Hello World!」

建立 OpenAPI 規格

建立 OpenAPI 規格，模擬呼叫 Node.js 伺服器的 API。

  1. 登入 apigee.com/edge。
  2. 在側邊導覽列中，依序選取「Develop」>「Specs」。
    系統會顯示規格清單。

  3. 按一下「+ 規格」，然後在下拉式選單中選取「新增規格」。

  4. 複製下列 YAML 內容：

    swagger: "2.0"
info:
  version: "0.0.1"
  title: Hello World API
host: 127.0.0.1:3000
basePath: /v1
schemes:
  - http
consumes:
 - application/json
produces:
  - application/json
paths:
  '/hello':
    get:
      description: Returns greetings to the caller
      operationId: hello
      responses:
        "200":
          description: Success
          schema:
            $ref: "#/definitions/HelloWorldResponse"
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
definitions:
  HelloWorldResponse:
    required:
      - message
    properties:
      message:
        type: string
      age:
        type: number
  ErrorResponse:
    required:
      - message
    properties:
      message:
        type: string

  5. 將 YAML 內容貼到編輯器的左側窗格 (覆寫目前的內容)。

  6. 按一下 [儲存]。
    系統會提示您為規格命名。

  7. 輸入規格的名稱，例如：simple-spec。

  8. 按一下「繼續」。
    系統會儲存規格。

  9. 按一下「關閉」關閉規格，並返回規格清單。

新規格隨即會顯示在規格清單中。

後續步驟

恭喜！您已建立第一個 OpenAPI 規格，用於模擬呼叫目標伺服器的 API。

接下來，瞭解如何使用 OpenAPI 規格建立 API Proxy。