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 کا استعمال کرتے ہوئے انٹیگریٹ کیا جائے۔ عملی طور پر، آپ کو سیکیورٹی، ورژننگ، کسٹم کنفیگریشن، اور دیگر تحفظات جیسے پہلوؤں پر غور کرنا چاہیے۔