close

Node.js API Gateway বাস্তবায়ন- Gateways এর সাথে API পরিচালনা করা 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:

অনুগ্রহ করে মনে রাখবেন যে এটি একটি এপিআই স্থাপন Gateway এবং Swagger Node.js ব্যবহার করে সংহত করার একটি সহজ উদাহরণ। অনুশীলনে, আপনার নিরাপত্তা, সংস্করণ, কাস্টম কনফিগারেশন এবং অন্যান্য বিবেচনার মতো দিক বিবেচনা করা উচিত।