আমি আমার প্রথম রেস্ট এপিআই তৈরি করছি যা জাসন এবং এক্সএমএল ফর্ম্যাটে ডেটা সিরিয়ালাইজ করে। আমি এপিআই ক্লায়েন্টদের একটি সূচক পৃষ্ঠা সরবরাহ করতে চাই, যেখানে তারা প্রয়োগকৃত শেষ পয়েন্টগুলি বেছে নিতে সক্ষম হবে।
আমার এপিআইকে সর্বাধিক দরকারী করে তুলতে আমার কোন তথ্য অন্তর্ভুক্ত করা দরকার এবং আমি কীভাবে এটি व्यवस्थित করব?
উত্তর:
এটি একটি সরল উত্তরের জন্য খুব জটিল প্রশ্ন।
আপনি সোয়াগার স্পেসিফিকেশন ( ওপেনপিআই ) এর মতো বিদ্যমান এপিআই ফ্রেমওয়ার্কগুলি এবং অ্যাপিয়ারি.আইও এবং এপিব্লুয়েপ্রিন্ট . org এর মতো পরিষেবাগুলিতে একবার নজর রাখতে পারেন ।
এছাড়াও, এখানে বর্ণিত, সংগঠিত এবং এমনকি তিনটি ভিন্ন উপায়ে স্টাইলযুক্ত একই REST এপিআইয়ের একটি উদাহরণ। বিদ্যমান প্রচলিত উপায়গুলি থেকে শেখা আপনার পক্ষে ভাল শুরু হতে পারে।
খুব শীর্ষ স্তরে আমি মনে করি মানের REST এপিআই ডক্সের জন্য কমপক্ষে নিম্নলিখিতটি প্রয়োজন:
এছাড়াও প্রচুর জেএসএন / এক্সএমএল-ভিত্তিক ডক ফ্রেমওয়ার্ক রয়েছে যা আপনার এপিআই সংজ্ঞা বা স্কিমা পার্স করতে পারে এবং আপনার জন্য ডক্সের একটি সুবিধাজনক সেট তৈরি করতে পারে। তবে ডক জেনারেশন সিস্টেমের জন্য পছন্দ আপনার প্রকল্প, ভাষা, বিকাশের পরিবেশ এবং অন্যান্য অনেক কিছুর উপর নির্ভর করে।