close

Node.js API Gateway कार्यान्वयन- API Gateways को साथ प्रबन्ध गर्दै Swagger

Gateway पुस्तकालयको साथ Node.js प्रयोग गरेर एपीआई सिर्जना गर्ने Express र Swagger एपीआई कागजातहरूको लागि एकीकरण निम्न रूपमा गर्न सकिन्छ:

चरण 1: परियोजना सेट अप गर्नुहोस् र पुस्तकालयहरू स्थापना गर्नुहोस्

  1. तपाईंको परियोजनाको लागि नयाँ निर्देशिका सिर्जना गर्नुहोस्।
  2. खोल्नुहोस् Command Prompt वा Terminal प्रोजेक्ट डाइरेक्टरीमा नेभिगेट गर्नुहोस् cd path_to_directory:।
  3. एनपीएम प्याकेज सुरु गर्नुहोस् 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 प्रयोग गरेर एकीकृत गर्ने सरल उदाहरण हो। अभ्यासमा, तपाईंले सुरक्षा, संस्करण, अनुकूलन कन्फिगरेसन, र अन्य विचारहरू जस्ता पक्षहरूलाई विचार गर्नुपर्छ।