יצירת מפרט OpenAPI

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

במדריך הזה תלמדו ליצור מפרט OpenAPI כדי לבנות מודל API שקורא לשרת יעד. שרת היעד מורכב משרת פשוט מאוד שמבוסס על Node.js, שיוצרים ומפעילים במחשב. השלמת המדריך נמשכת כ-10 דקות.

מה תלמדו

במדריך הזה תלמדו:

מה נדרש

כדי להתחיל:

יצירת שרת פשוט של 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 מחזיר את הערך: Hello 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. לוחצים על Close (סגירה) כדי לסגור את המפרט ולחזור לרשימה של המפרטים.

המפרט החדש יופיע ברשימת המפרטים.

מה השלב הבא?

מעולה! יצרתם את מפרט OpenAPI הראשון שלכם כדי ליצור מודל ל-API שמפעיל שרת יעד.

בשלב הבא תלמדו איך ליצור שרת proxy ל-API ממפרט OpenAPI.