יצירת מפרט 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 מחזיר: Hello World!‎

יצירת מפרט OpenAPI

כדי ליצור מפרט OpenAPI שמדמה את ה-API שקורא לשרת Node.js.

1. נכנסים לחשבון בכתובת apigee.com/edge.
2. בסרגל הניווט הצדדי, בוחרים באפשרות פיתוח > מפרטים.
   תוצג רשימת המפרטים.

3. לוחצים על + Spec (מפרט) ובוחרים באפשרות New Spec (מפרט חדש) בתפריט הנפתח.

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 שקורא לשרת יעד.

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