Gateway લાઇબ્રેરી સાથે Node.js નો ઉપયોગ કરીને API બનાવવું Express અને Swagger API દસ્તાવેજીકરણ માટે એકીકૃત કરવું નીચે પ્રમાણે કરી શકાય છે:
પગલું 1: પ્રોજેક્ટ સેટ કરો અને લાઇબ્રેરીઓ ઇન્સ્ટોલ કરો
- તમારા પ્રોજેક્ટ માટે નવી ડિરેક્ટરી બનાવો.
- પ્રોજેક્ટ ડિરેક્ટરી ખોલો Command Prompt અથવા નેવિગેટ કરો:. Terminal
cd path_to_directory
- એનપીએમ પેકેજ શરૂ કરો:
npm init -y
. - જરૂરી પુસ્તકાલયો ઇન્સ્ટોલ કરો:.
npm install express ocelot swagger-ui-express
પગલું 2: ગોઠવો Express અને ઓસેલોટ
app.js
પ્રોજેક્ટ ડિરેક્ટરીમાં નામવાળી ફાઇલ બનાવો અને તેને ગોઠવવા માટે ખોલો Express:
ocelot-config.json
તમારી વિનંતી રૂટીંગને વ્યાખ્યાયિત કરવા માટે નામવાળી રૂપરેખાંકન ફાઇલ બનાવો:
પગલું 3: એકીકૃત કરો Swagger
ફાઇલમાં app.js
, એકીકૃત કરવા માટે નીચેનો કોડ ઉમેરો Swagger:
swagger.json
પ્રોજેક્ટ ડિરેક્ટરીમાં નામવાળી ફાઇલ બનાવો અને API દસ્તાવેજીકરણ માહિતી વ્યાખ્યાયિત કરો:
પગલું 4: પ્રોજેક્ટ ચલાવો
પ્રોજેક્ટ ડિરેક્ટરી ખોલો Command Prompt અથવા નેવિગેટ કરો. Terminal
આદેશ સાથે પ્રોજેક્ટ ચલાવો: node app.js
.
પગલું 5: Swagger UI ઍક્સેસ કરો
Swagger સરનામાં પર UI ઍક્સેસ કરો: http://localhost:3000/api-docs
.
મહેરબાની કરીને નોંધ કરો કે આ એક API કેવી રીતે જમાવવું Gateway અને Swagger Node.js નો ઉપયોગ કરીને સંકલિત કરવું તેનું એક સરળ ઉદાહરણ છે. વ્યવહારમાં, તમારે સુરક્ષા, સંસ્કરણ, કસ્ટમ ગોઠવણી અને અન્ય વિચારણાઓ જેવા પાસાઓને ધ્યાનમાં લેવું જોઈએ.