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 మరియు 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ని ఉపయోగించి ఇంటిగ్రేట్ చేయడం ఎలా అనేదానికి ఇది ఒక సాధారణ ఉదాహరణ అని దయచేసి గమనించండి. ఆచరణలో, మీరు భద్రత, సంస్కరణ, అనుకూల కాన్ఫిగరేషన్ మరియు ఇతర పరిగణనలు వంటి అంశాలను పరిగణించాలి.