Tạo một bản đặc tả OpenAPI

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Trong hướng dẫn này, bạn sẽ tạo một OpenAPI Specification để mô hình hoá một API gọi một máy chủ đích. Máy chủ đích bao gồm một máy chủ rất đơn giản dựa trên Node.js mà bạn tạo và chạy trên máy của mình. Bạn sẽ mất khoảng 10 phút để hoàn thành hướng dẫn này.

Kiến thức bạn sẽ học được

Trong hướng dẫn này, bạn sẽ tìm hiểu cách:

Bạn cần có

Sau đây là những điều bạn cần để bắt đầu:

Tạo một máy chủ Node.js đơn giản

Cách tạo một máy chủ Node.js đơn giản:

  1. Tạo một tệp có tên là index.js.

  2. Sao chép mã Node.js sau đây vào tệp:

    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. Lưu tệp.

  4. Cài đặt mô-đun Express bắt buộc:

    npm install express

  5. Khởi động máy chủ:

    node index.js

    Thông báo sau đây sẽ được trả về:
    Example app listening on port 3000

  6. Kiểm thử API bằng cách gửi yêu cầu HTTP sau đây. 

    curl localhost:3000/v1/hello

    API trả về: Hello World!

Tạo một OpenAPI Specification

Để tạo một Quy cách OpenAPI mô hình hoá API gọi máy chủ Node.js.

  1. Đăng nhập vào apigee.com/edge.
  2. Chọn Phát triển > Thông số kỹ thuật trong thanh điều hướng bên.
    Danh sách quy cách sẽ xuất hiện.

  3. Nhấp vào + Spec rồi chọn New Spec trong trình đơn thả xuống.

  4. Sao chép nội dung YAML sau: 

    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. Dán nội dung YAML vào ngăn bên trái của trình chỉnh sửa (ghi đè nội dung hiện tại).

  6. Nhấp vào Lưu.
    Bạn sẽ được nhắc đặt tên cho quy cách.

  7. Nhập tên cho quy cách, chẳng hạn như: simple-spec.

  8. Nhấp vào Tiếp tục.
    Đã lưu quy cách.

  9. Nhấp vào Đóng để đóng quy cách và quay lại danh sách quy cách.

Quy cách mới sẽ xuất hiện trong danh sách quy cách.

Tiếp theo là gì?

Xin chúc mừng! Bạn đã tạo OpenAPI Specification đầu tiên để mô hình hoá một API gọi một máy chủ đích.

Tiếp theo, hãy tìm hiểu cách tạo một proxy API từ một Thông số kỹ thuật OpenAPI.