Node.js-API- Gateway Implementierung – API verwalten Gateways mit Swagger

Das Erstellen einer API Gateway mithilfe von Node.js mit der Express Bibliothek und die Integration Swagger für die API-Dokumentation kann wie folgt erfolgen:

Schritt 1: Projekt einrichten und Bibliotheken installieren

1. Erstellen Sie ein neues Verzeichnis für Ihr Projekt.
2. Öffnen Sie Command Prompt oder Terminal und navigieren Sie zum Projektverzeichnis: cd path_to_directory.
3. Initialisieren Sie ein NPM-Paket: npm init -y.
4. Erforderliche Bibliotheken installieren:. npm install express ocelot swagger-ui-express

Schritt 2: Konfigurieren Express und Ocelot

Erstellen Sie eine Datei mit dem Namen app.js im Projektverzeichnis und öffnen Sie sie zum Konfigurieren 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}`);  
});  

Erstellen Sie eine Konfigurationsdatei mit dem Namen, ocelot-config.json um Ihr Anforderungsrouting zu definieren:

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

Schritt 3: Integrieren Swagger

Fügen Sie in der app.js Datei den folgenden Code zur Integration hinzu 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));  

Erstellen Sie eine Datei mit dem Namen swagger.json im Projektverzeichnis und definieren Sie API-Dokumentationsinformationen:

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

Schritt 4: Führen Sie das Projekt aus

Öffnen Sie Command Prompt oder Terminal und navigieren Sie zum Projektverzeichnis.

Führen Sie das Projekt mit dem Befehl aus: node app.js.

Schritt 5: Greifen Sie auf Swagger die Benutzeroberfläche zu

Greifen Sie Swagger unter der Adresse auf die Benutzeroberfläche zu: http://localhost:3000/api-docs.

Bitte beachten Sie, dass dies ein einfaches Beispiel für die Bereitstellung einer API Gateway und die Integration Swagger mithilfe von Node.js ist. In der Praxis sollten Sie Aspekte wie Sicherheit, Versionierung, benutzerdefinierte Konfiguration und andere Überlegungen berücksichtigen.