יצירת מפרט 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. לוחצים על + מפרט ובוחרים באפשרות מפרט חדש בתפריט הנפתח.

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. לוחצים על Continue.
   המפרט נשמר.

9. לוחצים על סגירה כדי לסגור את המפרט ולנווט חזרה לרשימת המפרטים.

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

מה השלב הבא?

כל הכבוד! יצרת את מפרט OpenAPI הראשון שלך כדי לבנות מודל של ממשק API שקורא לשרת יעד.

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