close

Node.js API Gateway Implementation- 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: გაუშვით პროექტი

გახსენით Command Prompt ან Terminal და გადადით პროექტის დირექტორიაში.

გაუშვით პროექტი ბრძანებით: node app.js.

ნაბიჯი 5: წვდომა Swagger UI

წვდომა Swagger UI მისამართზე: http://localhost:3000/api-docs.

გთხოვთ გაითვალისწინოთ, რომ ეს არის მარტივი მაგალითი იმისა, თუ როგორ უნდა განათავსოთ API Gateway და ინტეგრირდეთ Swagger Node.js-ის გამოყენებით. პრაქტიკაში, თქვენ უნდა განიხილოთ ისეთი ასპექტები, როგორიცაა უსაფრთხოება, ვერსიის შექმნა, მორგებული კონფიგურაცია და სხვა მოსაზრებები.