إنشاء مواصفات OpenAPI

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

في هذا البرنامج التعليمي، يمكنك إنشاء مواصفات OpenAPI لنموذج واجهة برمجة تطبيقات تستدعي خادمًا مستهدفًا. يتألف الخادم المستهدف من خادم بسيط جدًا يستند إلى 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. اختبِر واجهة برمجة التطبيقات عن طريق إرسال طلب HTTP التالي. 

    curl localhost:3000/v1/hello

    تعرِض واجهة برمجة التطبيقات: Hello World!

إنشاء مواصفات OpenAPI

لإنشاء مواصفات OpenAPI التي تصمّم واجهة برمجة التطبيقات التي تستدعي خادم 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 الأولى لنموذج واجهة برمجة تطبيقات تستدعي خادمًا مستهدفًا.

بعد ذلك، تعرَّف على كيفية إنشاء خادم وكيل لواجهة برمجة التطبيقات من مواصفات OpenAPI.