close

Node.js API Gateway نفاذ- API Gateways کے ساتھ انتظام کرنا Swagger

Gateway لائبریری کے ساتھ Node.js کا استعمال کرتے ہوئے API بنانا Express اور Swagger API دستاویزات کے لیے انٹیگریٹ کرنا اس طرح کیا جا سکتا ہے:

مرحلہ 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 UI تک رسائی حاصل کریں۔

Swagger ایڈریس پر UI تک رسائی حاصل کریں: http://localhost:3000/api-docs.

براہ کرم نوٹ کریں کہ یہ ایک سادہ مثال ہے کہ کس طرح ایک API کو تعینات کیا جائے Gateway اور Swagger Node.js کا استعمال کرتے ہوئے انٹیگریٹ کیا جائے۔ عملی طور پر، آپ کو سیکیورٹی، ورژننگ، کسٹم کنفیگریشن، اور دیگر تحفظات جیسے پہلوؤں پر غور کرنا چاہیے۔