สร้างข้อกําหนด OpenAPI

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

ในบทแนะนํานี้ คุณจะได้สร้างข้อกําหนดของ OpenAPI เพื่อจําลอง API ที่เรียกเซิร์ฟเวอร์เป้าหมาย เซิร์ฟเวอร์เป้าหมายประกอบด้วยเซิร์ฟเวอร์ที่ใช้ Node.js ที่เรียบง่ายมากซึ่งคุณสร้างและเรียกใช้บนเครื่อง บทแนะนำนี้จะใช้เวลาประมาณ 10 นาที

สิ่งที่คุณจะได้เรียนรู้

ในบทแนะนำนี้ คุณจะได้เรียนรู้วิธีทำสิ่งต่อไปนี้

สิ่งที่คุณต้องมี

สิ่งที่ต้องใช้เพื่อเริ่มต้นใช้งานมีดังนี้

  • บัญชี Apigee Edge (ดูสร้างบัญชี Apigee Edge)
  • Node.js เวอร์ชันล่าสุด
  • เครื่องมือบรรทัดคำสั่ง curl
  • เครื่องมือแก้ไขข้อความ

สร้างเซิร์ฟเวอร์ 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. ทดสอบ API โดยส่งคําขอ HTTP ต่อไปนี้ 

    curl localhost:3000/v1/hello

    API ส่งกลับข้อความ สวัสดีชาวโลก

สร้างข้อกำหนด OpenAPI

วิธีสร้างข้อมูลจำเพาะ OpenAPI ที่จำลอง API ที่เรียกเซิร์ฟเวอร์ Node.js

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกพัฒนา > ข้อมูลจำเพาะในแถบนําทางด้านข้าง
    รายการข้อกําหนดจะปรากฏขึ้น

  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 ที่เรียกเซิร์ฟเวอร์เป้าหมายแล้ว

เรียนรู้วิธีสร้างพร็อกซี API จากข้อกำหนดของ OpenAPI