Sovellusliittymän luominen Gateway Node.js:n avulla kirjaston kanssa Express ja API-dokumentaation integrointi Swagger voidaan tehdä seuraavasti:
Vaihe 1: Määritä projekti ja asenna kirjastot
- Luo uusi hakemisto projektillesi.
- Avaa Command Prompt tai Terminal ja siirry projektihakemistoon:
cd path_to_directory. - Alusta npm-paketti:
npm init -y. - Asenna tarvittavat kirjastot:.
npm install express ocelot swagger-ui-express
Vaihe 2: Määritä Express ja Ocelot
app.js Luo projektihakemistoon nimetty tiedosto ja avaa se määrittääksesi 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}`);
});
Luo määritystiedosto, jonka nimi ocelot-config.json on määrittää pyyntösi reititys:
{
"Routes": [
{
"DownstreamPathTemplate": "/service1/{everything}",
"DownstreamScheme": "http",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/api/service1/{everything}",
"UpstreamHttpMethod": [ "GET", "POST", "PUT", "DELETE" ]
}
// Add other routes here
]
}
Vaihe 3: Integroi Swagger
Lisää tiedostoon app.js seuraava koodi integroidaksesi 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 Luo projektihakemistoon nimetty tiedosto ja määritä API-dokumentaatiotiedot:
{
"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
}
}
Vaihe 4: Suorita projekti
Avaa Command Prompt tai Terminal ja siirry projektihakemistoon.
Suorita projekti komennolla: node app.js.
Vaihe 5: Avaa Swagger käyttöliittymä
Käytä Swagger käyttöliittymää osoitteessa: http://localhost:3000/api-docs.
Huomaa, että tämä on yksinkertainen esimerkki API:n käyttöönotosta Gateway ja integroinnista Swagger Node.js:n avulla. Käytännössä sinun tulee ottaa huomioon esimerkiksi turvallisuus, versiointi, mukautetut asetukset ja muut näkökohdat.