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 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 પ્રોજેક્ટ ડિરેક્ટરીમાં નામવાળી ફાઇલ બનાવો અને 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 નો ઉપયોગ કરીને સંકલિત કરવું તેનું એક સરળ ઉદાહરણ છે. વ્યવહારમાં, તમારે સુરક્ષા, સંસ્કરણ, કસ્ટમ ગોઠવણી અને અન્ય વિચારણાઓ જેવા પાસાઓને ધ્યાનમાં લેવું જોઈએ.