Implementasi API Node.js Gateway- Ngatur API Gateways karo Swagger

Nggawe API Gateway nggunakake Node.js karo Express perpustakaan lan nggabungake Swagger dokumentasi API bisa ditindakake kaya ing ngisor iki:

Langkah 1: Nggawe Proyek lan Instal Pustaka

  1. Gawe direktori anyar kanggo proyek sampeyan.
  2. Bukak Command Prompt utawa Terminal lan navigasi menyang direktori proyek: cd path_to_directory.
  3. Miwiti paket npm: npm init -y.
  4. Instal perpustakaan sing dibutuhake:. npm install express ocelot swagger-ui-express

Langkah 2: Konfigurasi Express lan Ocelot

Gawe file sing dijenengi app.js ing direktori proyek lan bukak kanggo ngatur 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}`);  
});  

Gawe file konfigurasi sing dijenengi ocelot-config.json kanggo nemtokake rute panjalukan sampeyan:

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

Langkah 3: Integrasi Swagger

Ing app.js file, tambahake kode ing ngisor iki kanggo nggabungake 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));  

Nggawe file sing dijenengi swagger.json ing direktori proyek lan nemtokake informasi dokumentasi 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  
  }  
}  

Langkah 4: Jalanake Proyek

Bukak Command Prompt utawa Terminal lan navigasi menyang direktori proyek.

Jalanake proyek kanthi printah: node app.js.

Langkah 5: Akses Swagger UI

Akses Swagger UI ing alamat: http://localhost:3000/api-docs.

Wigati dimangerteni manawa iki minangka conto prasaja babagan carane nyebarake API Gateway lan nggabungake Swagger nggunakake Node.js. Ing praktik, sampeyan kudu nimbang aspek kayata keamanan, versi, konfigurasi khusus, lan pertimbangan liyane.