Stvaranje API-ja Gateway pomoću Node.js s Express bibliotekom i integracija Swagger za API dokumentaciju može se izvršiti na sljedeći način:
Korak 1: Postavite projekt i instalirajte biblioteke
- Napravite novi imenik za svoj projekt.
- Otvorite Command Prompt ili Terminal i idite do direktorija projekta:
cd path_to_directory
. - Inicijalizirajte npm paket:
npm init -y
. - Instalirajte potrebne biblioteke:.
npm install express ocelot swagger-ui-express
Korak 2: Konfigurirajte Express i Ocelot
Stvorite datoteku pod nazivom app.js
u direktoriju projekta i otvorite je za konfiguraciju 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}`);
});
Napravite konfiguracijsku datoteku pod nazivom ocelot-config.json
za definiranje usmjeravanja zahtjeva:
{
"Routes": [
{
"DownstreamPathTemplate": "/service1/{everything}",
"DownstreamScheme": "http",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/api/service1/{everything}",
"UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]
}
// Add other routes here
]
}
Korak 3: Integrirajte Swagger
U app.js
datoteku dodajte sljedeći kod za integraciju 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));
Stvorite datoteku pod nazivom swagger.json
u direktoriju projekta i definirajte informacije o dokumentaciji API-ja:
{
"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
}
}
Korak 4: Pokrenite projekt
Otvorite Command Prompt ili Terminal i idite do direktorija projekta.
Pokrenite projekt naredbom: node app.js
.
Korak 5: Pristup Swagger korisničkom sučelju
Pristup Swagger korisničkom sučelju na adresi: http://localhost:3000/api-docs
.
Imajte na umu da je ovo jednostavan primjer kako implementirati API Gateway i integrirati Swagger pomoću Node.js. U praksi biste trebali uzeti u obzir aspekte kao što su sigurnost, određivanje verzija, prilagođena konfiguracija i druga razmatranja.