Implementace Node.js API Gateway – Správa API Gateways s Swagger

Vytvoření API Gateway pomocí Node.js s Express knihovnou a integrace Swagger pro dokumentaci API lze provést následovně:

Krok 1: Nastavte projekt a nainstalujte knihovny

1. Vytvořte nový adresář pro váš projekt.
2. Otevřete Command Prompt nebo Terminal a přejděte do adresáře projektu: cd path_to_directory.
3. Inicializujte balíček npm: npm init -y.
4. Nainstalujte požadované knihovny:. npm install express ocelot swagger-ui-express

Krok 2: Konfigurace Express a Ocelot

Vytvořte soubor s názvem app.js v adresáři projektu a otevřete jej pro konfiguraci 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}`);  
});  

Vytvořte konfigurační soubor s názvem ocelot-config.json pro definování směrování vašeho požadavku:

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

Krok 3: Integrujte Swagger

Do app.js souboru přidejte následující kód pro integraci 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));  

Vytvořte soubor s názvem swagger.json v adresáři projektu a definujte informace o dokumentaci 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  
  }  
}  

Krok 4: Spusťte projekt

Otevřete Command Prompt nebo Terminal a přejděte do adresáře projektu.

Spusťte projekt příkazem: node app.js.

Krok 5: Přístup k Swagger uživatelskému rozhraní

Přístup k Swagger uživatelskému rozhraní na adrese: http://localhost:3000/api-docs.

Upozorňujeme, že toto je jednoduchý příklad toho, jak nasadit API Gateway a integrovat Swagger pomocí Node.js. V praxi byste měli zvážit aspekty, jako je zabezpečení, verzování, vlastní konfigurace a další aspekty.