หน้านี้ได้รับการแปลโดย Cloud Translation API

สร้างข้อกําหนด 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 แบบง่าย

สร้างไฟล์ชื่อ index.js

คัดลอกโค้ด 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!');
});

บันทึกไฟล์
ติดตั้งโมดูล Express ที่จำเป็น
```
npm install express
```
เริ่มเซิร์ฟเวอร์โดยทำดังนี้
```
node index.js
```
ข้อความต่อไปนี้จะแสดงผล:
Example app listening on port 3000
ทดสอบ API โดยส่งคำขอ HTTP ต่อไปนี้
```
curl localhost:3000/v1/hello
```
API ส่งกลับข้อความ สวัสดีชาวโลก

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

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

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

คัดลอกเนื้อหา 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

วางเนื้อหา YAML ในแผงด้านซ้ายของตัวแก้ไข (เขียนทับเนื้อหาปัจจุบัน)

หมายเหตุ: คุณสามารถคลิกขวาที่แผงด้านซ้ายของเครื่องมือแก้ไข แล้วเลือกเลือกทั้งหมดเพื่อไฮไลต์เนื้อหาปัจจุบัน จากนั้นคลิกขวาอีกครั้งและเลือกวาง เอกสารประกอบสำหรับข้อกำหนดจะแสดงในแผงด้านขวา
คลิกบันทึก
ระบบจะแจ้งให้คุณตั้งชื่อข้อกําหนด
ป้อนชื่อข้อกําหนด เช่น simple-spec
คลิกต่อไป
ระบบจะบันทึกข้อมูลจำเพาะแล้ว
คลิกปิดเพื่อปิดข้อกําหนดและกลับไปที่รายการข้อกําหนด

ข้อกําหนดใหม่จะแสดงในรายการข้อกําหนด

ขั้นตอนต่อไปคือ

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

ถัดไป ให้ดูวิธีสร้างพร็อกซี API จากข้อกำหนด OpenAPI