close

Gateway Εφαρμογή Node.js API- Διαχείριση API Gateways με Swagger

Η δημιουργία ενός API Gateway χρησιμοποιώντας το Node.js με τη Express βιβλιοθήκη και η ενσωμάτωση Swagger για την τεκμηρίωση του API μπορεί να γίνει ως εξής:

Βήμα 1: Ρύθμιση έργου και εγκατάσταση βιβλιοθηκών

  1. Δημιουργήστε έναν νέο κατάλογο για το έργο σας.
  2. Ανοίξτε Command Prompt ή Terminal και μεταβείτε στον κατάλογο του έργου: cd path_to_directory.
  3. Αρχικοποιήστε ένα πακέτο npm: npm init -y.
  4. Εγκαταστήστε τις απαιτούμενες βιβλιοθήκες:. npm install express ocelot swagger-ui-express

Βήμα 2: Διαμόρφωση Express και Ocelot

Δημιουργήστε ένα αρχείο με όνομα app.js στον κατάλογο του έργου και ανοίξτε το για να διαμορφώσετε 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}`);  
});

Δημιουργήστε ένα αρχείο διαμόρφωσης με το όνομα ocelot-config.json για να ορίσετε τη δρομολόγηση του αιτήματός σας:

{  
  "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: Ενσωμάτωση Swagger

Στο app.js αρχείο, προσθέστε τον ακόλουθο κώδικα για ενσωμάτωση 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));

Δημιουργήστε ένα αρχείο με όνομα swagger.json στον κατάλογο του έργου και ορίστε πληροφορίες τεκμηρίωσης 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  
  }  
}

Βήμα 4: Εκτελέστε το Project

Ανοίξτε το Command Prompt ή Terminal και μεταβείτε στον κατάλογο του έργου.

Εκτελέστε το έργο με την εντολή: node app.js.

Βήμα 5: Πρόσβαση Swagger στη διεπαφή χρήστη

Πρόσβαση στη Swagger διεπαφή χρήστη στη διεύθυνση: http://localhost:3000/api-docs.

Λάβετε υπόψη ότι αυτό είναι ένα απλό παράδειγμα για το πώς μπορείτε να αναπτύξετε ένα API Gateway και να ενσωματώσετε Swagger χρησιμοποιώντας το Node.js. Στην πράξη, θα πρέπει να λάβετε υπόψη πτυχές όπως η ασφάλεια, η έκδοση εκδόσεων, η προσαρμοσμένη διαμόρφωση και άλλα ζητήματα.