کامیاب اے پی آئی بنانے کے 5 اقدامات

یہ سافٹ ویئر کی ترقی کی نوعیت ہے۔ ڈویلپرز آخری صارف کو ذہن میں رکھتے ہوئے سافٹ ویئر تیار کرتے ہیں۔ یہ بہت آسان لگتا ہے ، لیکن بعض اوقات وہ صارف ساتھی ڈویلپر بھی ہوتے ہیں۔ انہیں ان کے لئے ٹوٹی ہوئی چیزوں کی ضرورت نہیں ہے۔ انہیں ضرورت نہیں یہاں تک کہ سادگی کی بھی ضرورت ہے۔ ان کے ساتھ اپنے سافٹ ویئر کو مربوط کرنے کا ایک طریقہ - وہ جو چاہتے ہیں وہ سب تک رسائی ہے۔ یہ وہ جگہ ہے جہاں ایک API (ایپلیکیشن پروگرامنگ انٹرفیس) آتا ہے۔ ، مجھے امید ہے کہ آپ ان پانچ اقدامات کو اجاگر کریں گے جو آپ ایک کامیاب API بنانے کے ل take اٹھاسکتے ہیں۔

اپنا ہومورک کرو

جب بات سافٹ ویئر ڈویلپمنٹ کی ہو تو ، ہم میں سے کوئی بھی پہیے کو بحال کرنا نہیں چاہتا ہے۔ اس وقت ، تقریبا تمام بڑی ویب کمپنیوں کے پاس اپنے سافٹ ویئر کی مصنوعات کے لئے API ہیں۔ ان APIs کا مطالعہ کریں اور ڈیزائن کے مختلف فیصلوں کو منتخب کرنے کی کوشش کریں جو ان کو بنانے میں ل into ہیں۔

وہاں بہت ساری مختلف ٹیکنالوجیز موجود ہیں ، لیکن آپ کو نظر آنے والے بیشتر APIs یا تو آرام دہ انٹرفیس یا SOAP استعمال کر رہے ہیں۔ اگر آپ باڑ پر ہیں کہ آپ کس API انٹرفیس کو استعمال کر رہے ہیں تو ، میں آپ کو HTTP پروٹوکول کا استعمال کرتے ہوئے آرام دہ انداز کے ساتھ جانے کا مشورہ دوں گا۔ یہ ایس او اے پی سے آسان ہے ، فی الحال یہ زیادہ مقبول ہے ، اور ویب پر مبنی سافٹ ویئر پروڈکٹ کا استعمال کرتے وقت اس کا آغاز کرنا آسان ہوجائے گا۔

مستقل مزاج رہو

ڈویلپرز جس چیز کی سب سے زیادہ تعریف کرتے ہیں ان میں سے ایک مستقل مزاجی ہے۔ اس میں ، دوسری چیزوں کے علاوہ ، پتہ کی اہلیت ، ان پٹ دلائل ، آؤٹ پٹ فارمیٹس اور غلطی سے نمٹنے شامل ہیں۔

آرام دہ اور پرسکون نقطہ نظر کا استعمال کرتے وقت ، بہت سے مختلف URI نام کی اسکیمیں موجود ہیں۔ ہر ایک کے پاس اس کے حامی ہیں ، لہذا صرف ایک منتخب کریں اور اس کے ساتھ قائم رہیں۔ ان پٹ اور آؤٹ پٹ ڈھانچہ کے ساتھ بھی ایسا ہی ہوتا ہے۔ زیادہ تر APIs ان پٹ اور آؤٹ پٹ فارمیٹس کے بطور XML اور JSON استعمال کرنے میں مدد کرتے ہیں۔ میں دونوں کی حمایت کرنے کا مشورہ دوں گا ، لیکن پہلے سے طے شدہ شکل منتخب کرنا۔

ان پٹ کے ل your ، آپ کی ان پٹ ضروریات کا نام مستقل طور پر رکھنا چاہئے اور آپ جو API کال کر رہے ہیں اس کے تناظر میں سمجھ میں آنا چاہئے۔ آؤٹ پٹ کے ل sure ، یہ یقینی بنائیں کہ آپ ڈیٹا سٹرکچر کی عام ترتیب کو استعمال کررہے ہیں۔ اگر آپ ایک میں ایک API کال کی آؤٹ پٹ ریپنگ کر رہے ہیں XML ٹیگ ، اپنی دوسری کالوں کے ساتھ ایسا کرنے پر غور کریں۔

یہ ایک عام رواج ہے کہ آپ کلائنٹ کو واپس بھیجنے والے آؤٹ پٹ ڈیٹا میں کسی قسم کے اسٹیٹس پرچم کو شامل کریں۔ RESTful API نقطہ نظر کا استعمال کرتے وقت ، یہ HTTP اسٹیٹس کوڈز کا استعمال کرتے ہوئے کیا جانا چاہئے۔ مثال کے طور پر ، اگر آپ نے کسی موجودہ ڈیٹا آبجیکٹ پر صرف PUT کی درخواست پر کارروائی کی ہے تو ، آپ کے جواب میں جو HTTP اسٹیٹ کوڈ شامل ہے وہ درخواست کے نتائج پر منحصر ہوتا ہے۔

کال کی حیثیت کی نشاندہی کرنے والے صوابدیدی جھنڈے کے بجائے ، ایک "200 اوکے" اسٹیٹس کوڈ کا استعمال اس بات کی نشاندہی کرنے کے لئے کیا جاسکتا ہے کہ درخواست کامیاب ہوگئی ، جب کہ "400 بری درخواست" کے اسٹیٹس کوڈ کو اس بات کی نشاندہی کرنے کے لئے استعمال کیا جاسکتا ہے کہ درخواست تھی خراب بہت کچھ HTTP اسٹیٹس کوڈ ہیں جو مختلف صورتحال میں استعمال ہوسکتے ہیں۔

OAuth استعمال کریں

زیادہ تر سوفٹویئر مصنوعات میں صارف کے محفوظ وسائل تک رسائی کے ل to کسی حد تک صارف کی توثیق ہوتی ہے۔ جب بات APIs کی ہو تو ، موکل کے پاس اپنے سرور کو بھیجنے کے لئے صارف کے اسناد جمع کرنا ایک بری عمل ہے۔ اسی جگہ OAuth آتا ہے۔

OAuth تیسری پارٹی کے صارف نام / پاس ورڈ کی توثیق سے کہیں زیادہ فوائد فراہم کرتا ہے۔ سب سے بڑھ کر ، موکل کے پاس کبھی بھی صارف کی اسناد تک رسائی نہیں ہوتی ہے۔ صارف آپ کے سرور پر ری ڈائریکٹ ہوجاتا ہے جب وہ آپ کے سائٹ میں لاگ ان ہوتا ہے۔ صارف آپ کی سائٹ پر لاگ ان ہوجانے کے بعد ، اسے دوبارہ کلائنٹ میں ری ڈائریکٹ کیا جاتا ہے جہاں کلائنٹ کو محفوظ وسائل کے ل future مستقبل کی درخواستوں میں استعمال کرنے کے لئے ایک ٹوکن موصول ہوگا۔

OAuth کو استعمال کرنے کا دوسرا اہم فائدہ صارف کی صلاحیت کسی بھی وقت مؤکل کی رسائی منسوخ کرنے کی ہے۔ اگر صارف یہ فیصلہ کرتا ہے کہ ، کسی بھی وجہ سے ، وہ اب نہیں چاہتا ہے کہ موکل ان کی طرف سے محفوظ وسائل تک رسائی حاصل کرے ، تو وہ صرف ایک انٹرفیس میں جاتے ہیں جس نے آپ نے تشکیل دیا ہے اور موکل کی رسائی منسوخ کردی ہے۔

جلدی سے شروع کریں

آپ اپنے API کو کامیاب بنانے کے لئے ایک اہم ترین کام جلد شروع کرنا ہے۔ جب آپ اپنے ڈیٹا بیس میں کچھ اندراج پیدا کرنے کے ل that اس فنکشن کو لکھتے ہیں تو ، آگے بڑھیں اور اضافی وقت نکالیں اور اس کے لئے ایک API انٹرفیس لکھیں۔

اچھی دستاویزات لکھیں

اچھ documentی دستاویزات نہ ہونے سے کسی API کو تیز تر نہیں مارتا ہے۔ اگرچہ کچھ ڈویلپرز ناقص دستاویزات والا API لے سکتے ہیں اور اندازہ لگاسکتے ہیں کہ اس کے کام کرنے کا طریقہ ، زیادہ تر نہیں کرنا چاہیں گے۔

آپ کو ہر ایک API کال کی دستاویز کرنی چاہئے جو آپ کے پاس دستیاب ہے اور اپنی API کالز کو جس طرح کے ڈیٹا پر عمل کرتے ہیں اس کی قسم سے درجہ بندی کریں۔ خود کو کال کرنے کے لئے اختتامی نکات کو دستاویز کرنے کے ساتھ ساتھ ، آپ کو مطلوبہ اور اختیاری ان پٹ دلائل کے ساتھ ساتھ آؤٹ پٹ ڈیٹا ڈھانچے کو منظم طریقے سے بیان کرنا چاہئے۔ ان پٹ دلیلوں کو ایک ڈیفالٹ ویلیو کی فہرست دینی چاہئے اگر وہ موجود ہو تو ، اور متوقع ڈیٹا فارمیٹ جیسے کسی نمبر یا سٹرنگ کی بھی نشاندہی کریں۔ آخر میں ، ہر API کال میں خرابی کے ضوابط اور اسٹیٹس کوڈ کی فہرست ہونی چاہئے۔

اپنی دستاویزات کو آگے بڑھانے کے ل be ، ہر API کال کے لئے عام ان پٹ اور آؤٹ پٹ منظرنامے کے لئے ایک یا دو مثالوں کو شامل کرنا یقینی بنائیں۔

API کی ترقی: اسے آسان رکھیں

اگرچہ ایسا لگتا ہے کہ ایک API تیار کرنا ایک پیچیدہ کوشش ہے ، لیکن خود ایک API کا خیال کوئی نیا تصور نہیں ہے اور یہاں ہم نے جس موضوع پر بھی بات کی ہے اس میں بڑی تعداد میں دستاویزات دستیاب ہیں۔ بس اچھے طریقوں کو استعمال کرنا یقینی بنائیں جہاں آپ انہیں تلاش کرسکیں ، اور مستقل ، اچھی طرح سے دستاویزی انٹرفیس فراہم کریں۔