close

تنفيذ Node.js API Gateway- إدارة واجهة برمجة التطبيقات Gateways باستخدام Swagger

يمكن إنشاء واجهة برمجة تطبيقات Gateway باستخدام Node.js مع Express المكتبة والتكامل مع وثائق واجهة برمجة التطبيقات على النحو التالي: Swagger

الخطوة 1: إعداد المشروع وتثبيت المكتبات

  1. قم بإنشاء دليل جديد لمشروعك.
  2. افتح Command Prompt أو Terminal وانتقل إلى دليل المشروع: cd path_to_directory.
  3. تهيئة حزمة npm: npm init -y.
  4. تثبيت المكتبات المطلوبة:. npm install express ocelot swagger-ui-express

الخطوة 2: تكوين Express وOcelot

قم بإنشاء ملف مسمى app.js في دليل المشروع وافتحه لتكوين Express:

const express = require('express');  
const app = express();  
const port = 3000;  
  
// Define routes here  
  
app.listen(port,() => {  
  console.log(`API Gateway is running at http://localhost:${port}`);  
});

قم بإنشاء ملف تكوين باسم ocelot-config.json لتحديد توجيه طلبك:

{  
  "Routes": [  
    {  
      "DownstreamPathTemplate": "/service1/{everything}",  
      "DownstreamScheme": "http",  
      "DownstreamHostAndPorts": [  
        {  
          "Host": "localhost",  
          "Port": 5001  
        }  
      ],  
      "UpstreamPathTemplate": "/api/service1/{everything}",  
      "UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]  
    }  
    // Add other routes here  
  ]  
}

الخطوة 3: التكامل Swagger

في app.js الملف، أضف الكود التالي للتكامل Swagger:

const swaggerUi = require('swagger-ui-express');  
const swaggerDocument = require('./swagger.json'); // Create a swagger.json file  
  
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

قم بإنشاء ملف مسمى swagger.json في دليل المشروع وحدد معلومات وثائق API:

{  
  "swagger": "2.0",  
  "info": {  
    "title": "API Gateway",  
    "version": "1.0.0"  
  },  
  "paths": {  
    "/api/service1/{everything}": {  
      "get": {  
        "summary": "Get data from Service 1",  
        "responses": {  
          "200": {  
            "description": "Successful response"  
          }  
        }  
      }  
    }  
    // Add definitions for other APIs here  
  }  
}

الخطوة 4: تشغيل المشروع

افتح Command Prompt أو Terminal وانتقل إلى دليل المشروع.

قم بتشغيل المشروع باستخدام الأمر: node app.js.

الخطوة 5: الوصول إلى Swagger واجهة المستخدم

الوصول إلى Swagger واجهة المستخدم على العنوان: http://localhost:3000/api-docs.

يرجى ملاحظة أن هذا مثال بسيط لكيفية نشر واجهة برمجة التطبيقات(API) Gateway والتكامل Swagger باستخدام Node.js. ومن الناحية العملية، يجب عليك مراعاة جوانب مثل الأمان، والإصدارات، والتكوين المخصص، واعتبارات أخرى.