建立 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。