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

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

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

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

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

• สร้างเซิร์ฟเวอร์ Node.js แบบง่ายๆ
• สร้างข้อกําหนดของ OpenAPI ที่สร้างโมเดล API ที่เรียกเซิร์ฟเวอร์ Node.js

สิ่งที่ต้องมี

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

• บัญชี 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 จะส่งกลับ: Hey World!

สร้างข้อมูลจำเพาะของ 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