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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Trong hướng dẫn này, bạn sẽ tạo một Thông số kỹ thuật OpenAPI để lập mô hình một API gọi máy chủ mục tiêu. Máy chủ đích bao gồm một máy chủ dựa trên Node.js rất đơn giản mà bạn tạo và chạy trên máy của mình. Hướng dẫn này cần khoảng 10 phút để hoàn tất.

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ó

Dưới đây là những việc bạn cần làm để 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 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. Hãy kiểm tra 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 thông số kỹ thuật OpenAPI

Để tạo Thông số kỹ thuật OpenAPI giúp 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 thông số kỹ thuật sẽ xuất hiện.

  3. Nhấp vào + Thông số kỹ thuật rồi chọn Thông số kỹ thuật mới 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 thông số kỹ thuật, chẳng hạn như: simple-spec.

  8. Nhấp vào Tiếp tục.
    Quy cách đã được lưu.

  9. Nhấp vào Đóng để đóng thông số kỹ thuật và quay lại danh sách thông số kỹ thuật.

Thông số kỹ thuật mới sẽ hiển thị trong danh sách thông số kỹ thuật.

Tiếp theo là gì?

Xin chúc mừng! Bạn đã tạo Thông số kỹ thuật OpenAPI đầu tiên để lập mô hình một API gọi máy chủ mục tiêu.

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