সুচিপত্র:
- আপনার হোম ওয়ার্ক করুন
- অটল থাক
- OAuth ব্যবহার করুন
- তাড়াতাড়ি শুরু করুন
- ভাল ডকুমেন্টেশন লিখুন
- এপিআই বিকাশ: এটিকে সহজ রাখুন
এটি সফ্টওয়্যার বিকাশের প্রকৃতি। ডেভেলপাররা শেষ ব্যবহারকারীর কথা মাথায় রেখে সফ্টওয়্যার তৈরি করে। এটি বেশ সহজ বলে মনে হচ্ছে, তবে কখনও কখনও সেই ব্যবহারকারীরাও সহযোগী বিকাশকারী হয়। তাদের জন্য ভেঙে পড়া জিনিসগুলির দরকার নেই। তাদের এমনকি সরলতার প্রয়োজন নেই। তারা যা চায় তা হ'ল অ্যাক্সেস - এটির সাথে আপনার সফ্টওয়্যারকে সংহত করার একটি উপায়। এখানেই একটি এপিআই (অ্যাপ্লিকেশন প্রোগ্রামিং ইন্টারফেস) আসে, আমি আশা করি একটি সফল এপিআই তৈরি করতে আপনি যে পাঁচটি পদক্ষেপ নিতে পারেন তা হাইলাইট করব।
আপনার হোম ওয়ার্ক করুন
যখন এটি সফ্টওয়্যার বিকাশের কথা আসে, আমরা কেউই চাকাটি পুনরায় উদ্ভাবন করতে চাই না। এই মুহুর্তে, প্রায় সমস্ত বড় ওয়েব সংস্থার তাদের সফ্টওয়্যার পণ্যগুলির জন্য এপিআই রয়েছে। এই এপিআইগুলি অধ্যয়ন করুন এবং সেগুলি তৈরির ক্ষেত্রে বিভিন্ন ডিজাইনের সিদ্ধান্ত গ্রহণের চেষ্টা করুন।
সেখানে অনেকগুলি ভিন্ন প্রযুক্তি রয়েছে, তবে আপনি দেখতে পাবেন এমন বেশিরভাগ এপিআই একটি আরএসএফুল ইন্টারফেস বা এসওএপি ব্যবহার করবে। আপনি যদি কোন এপিআই ইন্টারফেসটি ব্যবহার করতে চলেছেন সেই বেড়াতে থাকলে, আমি HTTP প্রোটোকলটি ব্যবহার করে একটি রেস্টস্টুল পদ্ধতির সাথে যেতে পরামর্শ দেব। এটি এসওএপি-এর চেয়ে সহজ, এটি বর্তমানে আরও জনপ্রিয় এবং ওয়েব-ভিত্তিক সফ্টওয়্যার পণ্য ব্যবহার করার সময় এটি শুরু করা সহজ হবে।
অটল থাক
বিকাশকারীরা যে জিনিসগুলির সর্বাধিক প্রশংসা করেন সেগুলির মধ্যে একটি হ'ল ধারাবাহিকতা। এর মধ্যে অন্যান্য বিষয়গুলির মধ্যে, ঠিকানাযোগ্যতা, ইনপুট আর্গুমেন্ট, আউটপুট ফর্ম্যাট এবং ত্রুটি পরিচালনা ling
একটি বিশ্রামের পদ্ধতি ব্যবহার করার সময়, বিভিন্ন ইউআরআই নামকরণের স্কিম রয়েছে। প্রত্যেকেরই এর সমর্থক রয়েছে, সুতরাং কেবল একটি বাছাই করুন এবং এটি দিয়ে আটকে দিন। একই ইনপুট এবং আউটপুট কাঠামো সঙ্গে যায়। বেশিরভাগ এপিআই XML এবং JSON ইনপুট এবং আউটপুট ফর্ম্যাট হিসাবে ব্যবহার করে সমর্থন করে। আমি উভয়কে সমর্থন করার পরামর্শ দিচ্ছি, তবে একটি ডিফল্ট ফর্ম্যাটটি বেছে নেব।
ইনপুট জন্য, আপনার ইনপুট প্রয়োজনীয়তা ধারাবাহিকভাবে নামকরণ করা উচিত এবং আপনি যে এপিআই কল করছেন তার প্রসঙ্গে অর্থ দেওয়া উচিত। আউটপুট জন্য, আপনি সাধারণ তথ্য কাঠামো লেআউট ব্যবহার করছেন তা নিশ্চিত করুন। আপনি যদি একটিতে একটি এপিআই কলের আউটপুট মোড়ানো করেন
আপনার ক্লায়েন্টকে ফেরত পাঠানো আউটপুট ডেটাতে কোনও ধরণের স্থিতি পতাকা অন্তর্ভুক্ত করা একটি সাধারণ অনুশীলন। একটি RESTful API পদ্ধতির ব্যবহার করার সময়, এটি HTTP স্থিতি কোডগুলি ব্যবহার করে করা উচিত। উদাহরণস্বরূপ, আপনি যদি কোনও বিদ্যমান ডেটা অবজেক্টের জন্য কেবল PUT অনুরোধটি প্রক্রিয়া করেন তবে আপনার প্রতিক্রিয়ায় অন্তর্ভুক্ত HTTP স্থিতি কোডটি অনুরোধের ফলাফলের উপর নির্ভর করে পরিবর্তিত হবে।
কলটির স্থিতি নির্দেশ করে এমন একটি স্বেচ্ছাকৃত পতাকাের পরিবর্তে, একটি আদর্শ "200 ওকে" স্থিতি কোডটি অনুরোধটি সফল হয়েছে তা বোঝাতে ব্যবহার করা যেতে পারে, যখন "400 বাজে অনুরোধ" স্থিতি কোডটি অনুরোধটি চিহ্নিত করতে ব্যবহার করা যেতে পারে বিকৃত হয়েছে। বেশ কয়েকটি এইচটিটিপি স্থিতি কোড রয়েছে যা বিভিন্ন পরিস্থিতিতে ব্যবহার করা যেতে পারে।
OAuth ব্যবহার করুন
বেশিরভাগ সফ্টওয়্যার পণ্যগুলি সেই ব্যবহারকারীর সুরক্ষিত সংস্থানগুলি অ্যাক্সেস করার জন্য কোনও প্রকারের ব্যবহারকারী প্রমাণীকরণের সাথে জড়িত। এটি যখন এআইপিআইয়ের কথা আসে তখন ক্লায়েন্টকে আপনার সার্ভারে প্রেরণের জন্য ব্যবহারকারীর শংসাপত্রগুলি সংগ্রহ করা খারাপ অভ্যাস। এখানেই OAuth আসে।
OAuth তৃতীয় পক্ষের ব্যবহারকারীর নাম / পাসওয়ার্ড প্রমাণীকরণের উপর অনেক সুবিধা দেয়। সর্বোপরি, ক্লায়েন্টের ব্যবহারকারীর শংসাপত্রগুলিতে কখনও অ্যাক্সেস থাকে না। ব্যবহারকারী যখন সে লগ ইন করে তখন আপনার সার্ভারে আপনাকে পুনঃনির্দেশিত করা হয় the ব্যবহারকারী আপনার সাইটে লগইন করার পরে, ক্লায়েন্টকে সুরক্ষিত সংস্থানগুলিতে ভবিষ্যতে অনুরোধগুলি ব্যবহার করার জন্য ক্লায়েন্ট একটি অ্যাক্সেস টোকন পাবেন back
OAuth ব্যবহারের আরেকটি গুরুত্বপূর্ণ সুবিধা হ'ল যে কোনও সময় ক্লায়েন্টের অ্যাক্সেস বাতিল করার ব্যবহারকারীর ক্ষমতা। যদি ব্যবহারকারী সিদ্ধান্ত নেয় যে কোনও কারণেই, তারা আর চায় না যে ক্লায়েন্টটি তাদের পক্ষে সুরক্ষিত সংস্থানগুলি অ্যাক্সেস করতে সক্ষম হবে, তারা কেবল আপনার তৈরি ইন্টারফেসে যান এবং ক্লায়েন্টের অ্যাক্সেস বাতিল করে।
তাড়াতাড়ি শুরু করুন
আপনার এপিআইকে সফল করতে আপনি করতে পারেন এমন একটি গুরুত্বপূর্ণ কাজ তাড়াতাড়ি শুরু করা। আপনি যখন আপনার ডাটাবেসে কিছু এন্ট্রি তৈরি করতে সেই ফাংশনটি লিখেন, তখন এগিয়ে যান এবং অতিরিক্ত সময় নিন এবং এর জন্য একটি API ইন্টারফেস লিখুন।ভাল ডকুমেন্টেশন লিখুন
ভাল ডকুমেন্টেশন না রাখার চেয়ে দ্রুত কোনও এপিআই মারা যায় না। কিছু বিকাশকারী একটি দুর্বল নথিভুক্ত এপিআই নিতে পারে এবং এটি কীভাবে কাজ করার কথা তা নির্ধারণ করতে পারে, তবে বেশিরভাগই তা চায় না।
আপনার উপলব্ধ প্রতিটি API কল নথিভুক্ত করা উচিত এবং আপনার এপিআই কলগুলি যে ধরণের ডেটা দ্বারা কাজ করে তার ধরণের দ্বারা শ্রেণিবদ্ধ করা উচিত। এপিআই কল করার জন্য শেষ পয়েন্টগুলি ডকুমেন্ট করার পাশাপাশি আপনার আউটপুট ডেটা স্ট্রাকচারের পাশাপাশি প্রয়োজনীয় এবং alচ্ছিক ইনপুট আর্গুমেন্টগুলি নিয়মিতভাবে সংজ্ঞায়িত করা উচিত। ইনপুট আর্গুমেন্টগুলির একটি সেখানে ডিফল্ট মান তালিকাভুক্ত করা উচিত, এবং একটি সংখ্যা বা স্ট্রিংয়ের মতো প্রত্যাশিত ডেটা ফর্ম্যাটটিকেও নির্দেশ করে। সবশেষে, প্রতিটি এপিআই কলটিতে ত্রুটি শর্ত এবং স্থিতি কোডগুলির একটি তালিকা থাকা উচিত।
আপনার ডকুমেন্টেশনের চারদিকে ঘুরে দেখার জন্য, প্রতিটি এপিআই কলের জন্য সাধারণ ইনপুট এবং আউটপুট পরিস্থিতিগুলির জন্য এক বা দুটি উদাহরণ অন্তর্ভুক্ত করার বিষয়ে নিশ্চিত হন।
এপিআই বিকাশ: এটিকে সহজ রাখুন
যদিও এটি মনে হতে পারে যে কোনও এপিআই বিকাশ একটি জটিল প্রচেষ্টা, তবে একটি এপিআই এর ধারণাটি কোনও নতুন ধারণা নয় এবং এখানে প্রতিটি বিষয়ের উপরে আমরা প্রচুর পরিমাণে উপলভ্য ডকুমেন্টেশন রয়েছে। আপনি যেগুলি খুঁজে পেতে পারেন সেখানে ভাল অনুশীলনগুলি ব্যবহার করতে এবং একটি ধারাবাহিক, ভাল ডকুমেন্টেড ইন্টারফেস সরবরাহ করার বিষয়ে নিশ্চিত হন।
