Implementimi i API-së Node.js Gateway- Menaxhimi i API- Gateways së me Swagger

Krijimi i një API Gateway duke përdorur Node.js me Express bibliotekën dhe integrimi Swagger për dokumentacionin API mund të bëhet si më poshtë:

Hapi 1: Vendosni projektin dhe instaloni bibliotekat

  1. Krijoni një drejtori të re për projektin tuaj.
  2. Hapni Command Prompt ose Terminal dhe lundroni te drejtoria e projektit: cd path_to_directory.
  3. Inicializoni një paketë npm: npm init -y.
  4. Instaloni bibliotekat e nevojshme:. npm install express ocelot swagger-ui-express

Hapi 2: Konfiguro Express dhe Ocelot

Krijoni një skedar të emërtuar app.js në drejtorinë e projektit dhe hapeni për të konfiguruar 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}`);  
});  

Krijoni një skedar konfigurimi të emërtuar ocelot-config.json për të përcaktuar rrugën e kërkesës suaj:

{  
  "Routes": [  
    {  
      "DownstreamPathTemplate": "/service1/{everything}",  
      "DownstreamScheme": "http",  
      "DownstreamHostAndPorts": [  
        {  
          "Host": "localhost",  
          "Port": 5001  
        }  
      ],  
      "UpstreamPathTemplate": "/api/service1/{everything}",  
      "UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]  
    }  
    // Add other routes here  
  ]  
}  

Hapi 3: Integrimi Swagger

app.js skedar, shtoni kodin e mëposhtëm për t'u integruar 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));  

Krijoni një skedar të emërtuar swagger.json në drejtorinë e projektit dhe përcaktoni informacionin e dokumentacionit 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  
  }  
}  

Hapi 4: Drejtoni projektin

Hapni Command Prompt ose Terminal dhe lundroni te drejtoria e projektit.

Ekzekutoni projektin me komandën: node app.js.

Hapi 5: Hyni në Swagger UI

Hyni në Swagger UI në adresën: http://localhost:3000/api-docs.

Ju lutemi vini re se ky është një shembull i thjeshtë se si të vendosni një API Gateway dhe të integroni Swagger duke përdorur Node.js. Në praktikë, duhet të merrni parasysh aspekte të tilla si siguria, versionimi, konfigurimi i personalizuar dhe konsiderata të tjera.