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
- Cruthaigh eolaire nua do do thionscadal.
- Oscail Command Prompt nó Terminal agus déan nascleanúint chuig an eolaire tionscadail:
cd path_to_directory
. - Tosaigh pacáiste npm:
npm init -y
. - 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:
Cruthaigh comhad cumraíochta ainmnithe ocelot-config.json
chun do ródú iarratais a shainiú:
Céim 3: Comhtháthú Swagger
Sa app.js
chomhad, cuir an cód seo a leanas leis chun Swagger:
Cruthaigh comhad atá ainmnithe swagger.json
san eolaire tionscadail agus sainmhínigh faisnéis doiciméadúcháin API:
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.