Node.js API Gateway diegimas – API valdymas Gateways naudojant Swagger

Sukurti API Gateway naudojant Node.js su Express biblioteka ir integruoti Swagger API dokumentaciją galima taip:

1 veiksmas: nustatykite projektą ir įdiekite bibliotekas

1. Sukurkite naują savo projekto katalogą.
2. Atidarykite Command Prompt arba Terminal ir eikite į projekto katalogą: cd path_to_directory.
3. Inicijuoti npm paketą: npm init -y.
4. Įdiekite reikalingas bibliotekas:. npm install express ocelot swagger-ui-express

2 veiksmas: konfigūruokite Express ir „Ocelot“.

Sukurkite failą, pavadintą app.js projekto kataloge, ir atidarykite jį, kad sukonfigūruotumėte 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}`);  
});  

Sukurkite konfigūracijos failą, pavadintą ocelot-config.json, kad nustatytumėte užklausos maršrutą:

{  
  "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 veiksmas: integruokite Swagger

Norėdami integruoti, faile app.js pridėkite šį kodą 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));  

Sukurkite failą, pavadintą swagger.json projekto kataloge, ir apibrėžkite API dokumentacijos informaciją:

{  
  "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 veiksmas: paleiskite projektą

Atidarykite Command Prompt arba Terminal ir eikite į projekto katalogą.

Vykdykite projektą naudodami komandą: node app.js.

5 veiksmas: pasiekite Swagger vartotojo sąsają

Prisijunkite Swagger prie vartotojo sąsajos adresu: http://localhost:3000/api-docs.

Atminkite, kad tai yra paprastas pavyzdys, kaip įdiegti API Gateway ir integruoti Swagger naudojant Node.js. Praktiškai turėtumėte atsižvelgti į tokius aspektus kaip sauga, versijų kūrimas, pasirinktinė konfigūracija ir kiti aspektai.