Gateway நூலகத்துடன் Node.js ஐப் பயன்படுத்தி API ஐ உருவாக்குதல் Express மற்றும் Swagger API ஆவணங்களை ஒருங்கிணைத்தல் பின்வருமாறு:
படி 1: திட்டத்தை அமைத்து நூலகங்களை நிறுவவும்
- உங்கள் திட்டத்திற்கான புதிய கோப்பகத்தை உருவாக்கவும்.
- திட்டக் கோப்பகத்தைத் திறக்கவும் Command Prompt அல்லது Terminal அதற்குச் செல்லவும்:
cd path_to_directory
. - ஒரு npm தொகுப்பை துவக்கவும்:
npm init -y
. - தேவையான நூலகங்களை நிறுவவும்:.
npm install express ocelot swagger-ui-express
படி 2: கட்டமைத்தல் Express மற்றும் Ocelot
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 ஐப் பயன்படுத்தி ஒருங்கிணைப்பது என்பதற்கான எளிய எடுத்துக்காட்டு இது என்பதை நினைவில் கொள்ளவும். நடைமுறையில், பாதுகாப்பு, பதிப்பு, தனிப்பயன் உள்ளமைவு மற்றும் பிற பரிசீலனைகள் போன்ற அம்சங்களை நீங்கள் கருத்தில் கொள்ள வேண்டும்.