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:
Hozzon létre egy konfigurációs fájlt ocelot-config.json
a kérés útvonalának meghatározásához:
3. lépés: Integráljon Swagger
app.js
Az integráláshoz adja hozzá a következő kódot a fájlhoz Swagger:
Hozzon létre egy nevű fájlt swagger.json
a projektkönyvtárban, és határozza meg az API dokumentációs adatait:
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.