ডিসকভারি API প্রতিটি API-এর জন্য একটি মেশিন-পাঠযোগ্য "ডিসকভারি ডকুমেন্ট" মেটাডেটা পুনরুদ্ধার করার জন্য Google API-এর একটি তালিকা প্রদান করে।
এই ডকুমেন্টটি ডেভেলপারদের জন্য যারা ক্লায়েন্ট লাইব্রেরি, IDE প্লাগইন এবং Google API-এর সাথে ইন্টারঅ্যাক্ট করার জন্য অন্যান্য টুল লিখতে চান।
ডিসকভারি সার্ভিস ব্যাকগ্রাউন্ড
ধারণা
Google APIs আবিষ্কার পরিষেবা দুটি মৌলিক ধারণার উপর নির্মিত:
- APIs ডিরেক্টরি : APIs আবিষ্কার পরিষেবা দ্বারা সমর্থিত সমস্ত APIগুলির একটি তালিকা৷ প্রতিটি ডিরেক্টরি এন্ট্রি একটি সমর্থিত API সম্পর্কে বিশদ বিবরণ দেখায়, এর নাম সহ, এটি কী করে তার একটি সংক্ষিপ্ত বিবরণ এবং একটি ডকুমেন্টেশন লিঙ্ক । একটি API এর একাধিক ডিরেক্টরি এন্ট্রি থাকতে পারে, প্রতিটি সমর্থিত সংস্করণের জন্য একটি।
- আবিষ্কার নথি : একটি নির্দিষ্ট API এর একটি মেশিন-পাঠযোগ্য বিবরণ। ডিসকভারি ডকুমেন্ট একটি API এর একটি নির্দিষ্ট সংস্করণের জন্য পৃষ্ঠকে বর্ণনা করে। নথিটি RESTful HTTP কলের মাধ্যমে প্রতিটি API-এর বিভিন্ন পদ্ধতিতে কীভাবে অ্যাক্সেস করতে হয় তার বিশদ প্রদান করে। একটি ডিসকভারি নথিতে API-এর সাথে সম্পর্কিত ডেটা এবং পদ্ধতির বিবরণ, সেইসাথে উপলব্ধ OAuth স্কোপ এবং স্কিমা, পদ্ধতি, প্যারামিটার এবং উপলব্ধ প্যারামিটার মানগুলির বিবরণ অন্তর্ভুক্ত থাকে।
তথ্য মডেল
একটি সম্পদ একটি অনন্য শনাক্তকারী সহ একটি পৃথক ডেটা সত্তা। উপরের ধারণার উপর ভিত্তি করে Google APIs ডিসকভারি সার্ভিস দুই ধরনের সম্পদের উপর কাজ করে।
APIs ডিরেক্টরি তালিকা : API-এর একটি তালিকা
প্রতিটি ডিরেক্টরি এন্ট্রিতে নিম্নলিখিত তথ্য সহ একটি API নাম / সংস্করণ জোড়া রয়েছে:
- সনাক্তকরণ এবং বিবরণ তথ্য, : নাম, সংস্করণ, শিরোনাম, এবং বিবরণ।
- ডকুমেন্টেশন তথ্য : আইকন এবং একটি ডকুমেন্টেশন লিঙ্ক.
- স্থিতির তথ্য , স্ট্যাটাস লেবেল সহ, এবং এটি API-এর পছন্দের সংস্করণ কিনা সে সম্পর্কে একটি ইঙ্গিত৷
- ডিসকভারি ডকুমেন্ট লিংক , এই API-এর জন্য ডিসকভারি ডকুমেন্টের URI (সম্পূর্ণ URL হিসেবে দেওয়া হয়েছে, যেমন https://servicemanagement.googleapis.com/$discovery/rest?version=v1)।
ডিসকভারি ডকুমেন্ট রিসোর্স : একটি নির্দিষ্ট API-এর একটি মেশিন-পাঠযোগ্য বিবরণ
APIs ডিরেক্টরিতে প্রদত্ত তথ্য ছাড়াও, একটি আবিষ্কার নথিতেও রয়েছে:
- স্কিমা , যা API রিসোর্স স্কিমাগুলির একটি তালিকা যা প্রতিটি API-তে আপনার অ্যাক্সেস থাকা ডেটা বর্ণনা করে; Google APIs ডিসকভারি সার্ভিস স্কিমাগুলি JSON স্কিমার উপর ভিত্তি করে।
- পদ্ধতি , প্রতিটি পদ্ধতির জন্য API পদ্ধতির তালিকা এবং উপলব্ধ পরামিতি সহ।
- OAuth স্কোপ , যা এই API-এর জন্য উপলব্ধ OAuth স্কোপের তালিকা চিহ্নিত করে।
- ইনলাইন ডকুমেন্টেশন , যা স্কিমা, পদ্ধতি, প্যারামিটার এবং উপলব্ধ প্যারামিটার মানগুলির সংক্ষিপ্ত বিবরণ প্রদান করে।
একক ডিরেক্টরি সংগ্রহ হল একক APIs ডিরেক্টরি সংস্থানের ধারণাগত ধারক, এবং প্রতিটি সমর্থিত API-এর জন্য আবিষ্কার নথি সম্পদ।
APIs ডিরেক্টরি সংস্থান এবং আবিষ্কার নথি সংস্থান সম্পর্কে আরও বিশদ API এবং রেফারেন্স নথি ব্যবহারে সরবরাহ করা হয়েছে।
অপারেশন
আপনি Google APIs ডিসকভারি সার্ভিসে সংগ্রহ এবং সম্পদের জন্য দুটি ভিন্ন পদ্ধতি ব্যবহার করতে পারেন, যেমনটি নিম্নলিখিত টেবিলে বর্ণিত হয়েছে।
| অপারেশন | বর্ণনা | REST HTTP ম্যাপিং |
|---|---|---|
| তালিকা | সমস্ত সমর্থিত API তালিকা করে। | ডিরেক্টরি রিসোর্স ইউআরআই-এ GET । |
কলিং শৈলী
বিশ্রাম
সমর্থিত Google APIs ডিসকভারি সার্ভিস অপারেশনগুলি সরাসরি REST HTTP GET ক্রিয়াকে ম্যাপ করে, যেমনটি অপারেশনগুলিতে বর্ণিত হয়েছে।
গুগল এপিআই ডিসকভারি সার্ভিস ইউআরআই-এর জন্য নির্দিষ্ট ফরম্যাট হল:
https://discovery.googleapis.com/discovery/v1/apis?parameters
যেখানে api হল একটি ডিসকভারি ডকুমেন্ট রিসোর্সের শনাক্তকারী, এবং version হল API-এর নির্দিষ্ট সংস্করণের শনাক্তকারী, এবং _parameters_ হল যেকোন প্যারামিটার কোয়েরিতে প্রযোজ্য। বিস্তারিত জানার জন্য রেফারেন্স ডকুমেন্টেশনে কোয়েরি প্যারামিটার সারাংশ দেখুন
API-এ প্রতিটি সমর্থিত ক্রিয়াকলাপের জন্য ব্যবহৃত URI-এর সম্পূর্ণ সেটের বিবরণ Google APIs আবিষ্কার পরিষেবা রেফারেন্স নথিতে সংক্ষিপ্ত করা হয়েছে।
গুগল এপিআই ডিসকভারি সার্ভিসে এটি কীভাবে কাজ করে তার কয়েকটি উদাহরণ এখানে রয়েছে।
সমস্ত Google API ডিসকভারি সার্ভিস সমর্থিত API তালিকা করুন:
GET https://discovery.googleapis.com/discovery/v1/apis
APIs এক্সপ্লোরারে এখন এটি চেষ্টা করুন!
Google ক্লাউড সার্ভিস ম্যানেজমেন্ট API, সংস্করণ 1-এর জন্য আবিষ্কার নথি পান:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1