close

Node.js API Gateway ਲਾਗੂ ਕਰਨਾ- Gateways ਨਾਲ API ਦਾ ਪ੍ਰਬੰਧਨ ਕਰਨਾ Swagger

Gateway ਲਾਇਬ੍ਰੇਰੀ ਦੇ ਨਾਲ Node.js ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ ਇੱਕ API ਬਣਾਉਣਾ 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 ਅਤੇ ਓਸੇਲੋਟ

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 ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਏਕੀਕ੍ਰਿਤ ਕਰਨਾ ਹੈ। ਅਭਿਆਸ ਵਿੱਚ, ਤੁਹਾਨੂੰ ਸੁਰੱਖਿਆ, ਸੰਸਕਰਣ, ਕਸਟਮ ਕੌਂਫਿਗਰੇਸ਼ਨ, ਅਤੇ ਹੋਰ ਵਿਚਾਰਾਂ ਵਰਗੇ ਪਹਿਲੂਆਂ 'ਤੇ ਵਿਚਾਰ ਕਰਨਾ ਚਾਹੀਦਾ ਹੈ।