close

Node.js API Gateway Uygulaması- API'yi Gateways şununla yönetme: Swagger

Gateway Kütüphaneyle Node.js kullanarak bir API oluşturmak Express ve Swagger API dokümantasyonu için entegrasyon aşağıdaki şekilde yapılabilir:

1. Adım: Projeyi Kurun ve Kitaplıkları Yükleyin

  1. Projeniz için yeni bir dizin oluşturun.
  2. Command Prompt veya öğesini açın Terminal ve proje dizinine gidin: cd path_to_directory.
  3. Bir npm paketini başlatın: npm init -y.
  4. Gerekli kütüphaneleri yükleyin:. npm install express ocelot swagger-ui-express

Adım 2: Yapılandırma Express ve Ocelot

app.js Proje dizininde adlı bir dosya oluşturun ve yapılandırmak için açın 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 İstek yönlendirmenizi tanımlamak için adlı bir yapılandırma dosyası oluşturun:

{  
  "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. Adım: Entegrasyon Swagger

Dosyaya app.js entegre etmek için aşağıdaki kodu ekleyin 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 Proje dizininde adlandırılmış bir dosya oluşturun ve API dokümantasyon bilgilerini tanımlayın:

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

Adım 4: Projeyi Çalıştırın

Command Prompt veya öğesini açın Terminal ve proje dizinine gidin.

Projeyi şu komutla çalıştırın: node app.js.

5. Adım: Kullanıcı Swagger arayüzüne erişin

Swagger Kullanıcı arayüzüne şu adresten erişin: http://localhost:3000/api-docs.

Bunun, bir API'nin nasıl dağıtılacağına Gateway ve Swagger Node.js kullanılarak nasıl entegre edileceğine ilişkin basit bir örnek olduğunu lütfen unutmayın. Uygulamada güvenlik, sürüm oluşturma, özel yapılandırma ve diğer hususlar gibi hususları dikkate almalısınız.