Gateway Feidhmiú API Node.js- API a bhainistiú Gateways le Swagger

Is féidir API a chruthú Gateway ag baint úsáide as Node.js leis an Express leabharlann agus comhtháthú Swagger le haghaidh doiciméadú API a dhéanamh mar seo a leanas:

Céim 1: Socraigh suas Tionscadal agus Suiteáil Leabharlanna

1. Cruthaigh eolaire nua do do thionscadal.
2. Oscail Command Prompt nó Terminal agus déan nascleanúint chuig an eolaire tionscadail: cd path_to_directory.
3. Tosaigh pacáiste npm: npm init -y.
4. Suiteáil leabharlanna riachtanacha:. npm install express ocelot swagger-ui-express

Céim 2: Cumraigh Express agus Ocelot

Cruthaigh comhad atá ainmnithe app.js san eolaire tionscadail agus oscail é chun 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}`);  
});  

Cruthaigh comhad cumraíochta ainmnithe ocelot-config.json chun do ródú iarratais a shainiú:

{  
  "Routes": [  
    {  
      "DownstreamPathTemplate": "/service1/{everything}",  
      "DownstreamScheme": "http",  
      "DownstreamHostAndPorts": [  
        {  
          "Host": "localhost",  
          "Port": 5001  
        }  
      ],  
      "UpstreamPathTemplate": "/api/service1/{everything}",  
      "UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]  
    }  
    // Add other routes here  
  ]  
}  

Céim 3: Comhtháthú Swagger

Sa app.js chomhad, cuir an cód seo a leanas leis chun 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));  

Cruthaigh comhad atá ainmnithe swagger.json san eolaire tionscadail agus sainmhínigh faisnéis doiciméadúcháin 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  
  }  
}  

Céim 4: Rith an Tionscadal

Oscail Command Prompt nó Terminal agus déan nascleanúint chuig an eolaire tionscadail.

Rith an tionscadal leis an ordú: node app.js.

Céim 5: Swagger Chomhéadain Rochtain

Faigh rochtain ar Swagger Chomhéadain ag an seoladh: http://localhost:3000/api-docs.

Tabhair faoi deara le do thoil gur sampla simplí é seo de conas API a imscaradh Gateway agus a chomhtháthú Swagger le Node.js. Go praiticiúil, ba cheart duit gnéithe cosúil le slándáil, leagan, cumraíocht saincheaptha, agus gnéithe eile a mheas.