close

Node.js API அமலாக்கம்- உடன் Gateway API மேலாண்மை Gateways 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 ஐப் பயன்படுத்தி ஒருங்கிணைப்பது என்பதற்கான எளிய எடுத்துக்காட்டு இது என்பதை நினைவில் கொள்ளவும். நடைமுறையில், பாதுகாப்பு, பதிப்பு, தனிப்பயன் உள்ளமைவு மற்றும் பிற பரிசீலனைகள் போன்ற அம்சங்களை நீங்கள் கருத்தில் கொள்ள வேண்டும்.