close

Node.js एपीआई Gateway कार्यान्वयन- एपीआई 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 और ओसेलॉट करें

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 प्रोजेक्ट निर्देशिका में नामित एक फ़ाइल बनाएं और एपीआई दस्तावेज़ीकरण जानकारी परिभाषित करें:

{  
  "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.

कृपया ध्यान दें कि यह एक सरल उदाहरण है कि कैसे एक एपीआई को तैनात किया जाए Gateway और Swagger Node.js का उपयोग करके एकीकृत किया जाए। व्यवहार में, आपको सुरक्षा, संस्करण, कस्टम कॉन्फ़िगरेशन और अन्य पहलुओं जैसे पहलुओं पर विचार करना चाहिए।