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

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

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

מה השלב הבא?

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

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