Az API létrehozása Gateway Node.js használatával a Express könyvtárral és Swagger az API dokumentációba való integrálása a következőképpen végezhető el:
1. lépés: A projekt beállítása és a könyvtárak telepítése
- Hozzon létre egy új könyvtárat a projekthez.
- Nyissa meg Command Prompt a vagy Terminal a projektkönyvtárat:
cd path_to_directory. - npm-csomag inicializálása:
npm init -y. - Telepítse a szükséges könyvtárakat:.
npm install express ocelot swagger-ui-express
2. lépés: Konfigurálás Express és Ocelot
Hozzon létre egy nevű fájlt app.js a projektkönyvtárban, és nyissa meg a beállításhoz 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}`);
});
Hozzon létre egy konfigurációs fájlt ocelot-config.json a kérés útvonalának meghatározásához:
{
"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. lépés: Integráljon Swagger
app.js Az integráláshoz adja hozzá a következő kódot a fájlhoz 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));
Hozzon létre egy nevű fájlt swagger.json a projektkönyvtárban, és határozza meg az API dokumentációs adatait:
{
"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. lépés: Futtassa a projektet
Nyissa meg Command Prompt a vagy Terminal a projektkönyvtárat.
Futtassa a projektet a következő paranccsal: node app.js.
5. lépés: Nyissa meg a felhasználói Swagger felületet
Hozzáférés Swagger a felhasználói felülethez a következő címen: http://localhost:3000/api-docs.
Felhívjuk figyelmét, hogy ez egy egyszerű példa egy API üzembe helyezésére Gateway és Swagger a Node.js használatával történő integrálására. A gyakorlatban olyan szempontokat kell figyelembe vennie, mint a biztonság, a verziószám, az egyéni konfiguráció és egyéb szempontok.