डिस्कवरी एपीआई, हर एपीआई के लिए मेटाडेटा को पढ़ने के लिए Google API की एक सूची देता है. इस एपीआई में मशीन से पढ़ा जाने वाला और खोज से जुड़ा दस्तावेज़ और कोट मौजूद होता है.
यह दस्तावेज़ उन डेवलपर के लिए है जो क्लाइंट एपीआई लिखने के लिए क्लाइंट लाइब्रेरी, आईडीई प्लग इन, और दूसरे टूल लिखना चाहते हैं.
डिस्कवरी सर्विस बैकग्राउंड
कॉन्सेप्ट
Google API डिस्कवरी सर्विस, दो बुनियादी सिद्धांतों के आधार पर बनाई गई है:
- एपीआई डायरेक्ट्री: उन सभी एपीआई की सूची जो एपीआई डिस्कवरी सर्विस के साथ काम करते हैं. हर डायरेक्ट्री में, काम करने वाले एपीआई के बारे में जानकारी दिखती है. इसमें नाम, उसके काम का छोटा सा ब्यौरा, और दस्तावेज़ का लिंक शामिल होता है. किसी एपीआई में एक से ज़्यादा डायरेक्ट्री एंट्री हो सकती हैं. हर एंट्री के लिए, एक वर्शन का इस्तेमाल किया जा सकता है.
- डिस्कवरी दस्तावेज़: किसी खास एपीआई को मशीन के ज़रिए पढ़ा जा सकता है. डिस्कवरी दस्तावेज़ में, एपीआई के किसी खास वर्शन के बारे में जानकारी दी गई है. इस दस्तावेज़ में, RESTful एचटीटीपी कॉल की मदद से, एपीआई के अलग-अलग तरीकों को ऐक्सेस करने के तरीके के बारे में जानकारी दी गई है. डिस्कवरी दस्तावेज़ में डेटा से जुड़े ब्यौरे और एपीआई से जुड़े तरीके शामिल हैं. साथ ही, उपलब्ध OAuth दायरों और स्कीमा, तरीकों, पैरामीटर, और उपलब्ध पैरामीटर वैल्यू के बारे में भी जानकारी शामिल होती है.
डेटा मॉडल
संसाधन एक ऐसी इकाई होती है जिसकी डेटा आइडेंटिफ़ायर एक खास पहचान होती है. Google API डिस्कवरी सर्विस, ऊपर बताए गए सिद्धांतों के आधार पर दो तरह के संसाधनों पर काम करती है.
एपीआई डायरेक्ट्री की सूची: एपीआई की सूची
हर डायरेक्ट्री में, नीचे दी गई जानकारी के साथ एपीआई नाम/वर्शन जोड़ा जाता है:
- पहचान और ब्यौरे की जानकारी: नाम, वर्शन, शीर्षक, और ब्यौरा.
- दस्तावेज़ की जानकारी: आइकॉन और दस्तावेज़ का लिंक.
- स्थिति की जानकारी, जिसमें स्टेटस लेबल भी शामिल हैं. साथ ही, इस बात की जानकारी भी दी गई है कि यह एपीआई का पसंदीदा वर्शन है या नहीं.
- खोज से जुड़े दस्तावेज़ का लिंक, इस एपीआई के डिस्कवरी दस्तावेज़ का यूआरआई (उदाहरण के लिए, पूरा यूआरएल डालें, जैसे कि https://serviceमैनेज.googleapis.com/$डिस्कवरy/rest?version=v1).
डिस्कवरी दस्तावेज़ से जुड़े संसाधन: किसी खास एपीआई को मशीन से पढ़कर सुनाने की सुविधा
एपीआई डायरेक्ट्री में दी गई जानकारी के अलावा, डिस्कवरी दस्तावेज़ में ये चीज़ें भी शामिल होती हैं:
- स्कीमा, एपीआई संसाधनों की एक ऐसी सूची होती है जो यह बताती है कि आपके पास हर एपीआई में मौजूद डेटा का इस्तेमाल कैसे किया जाता है. Google API डिस्कवरी सेवा स्कीमा JSON स्कीमा पर आधारित होती हैं.
- मैथड, जिनमें एपीआई के तरीकों की सूची और हर तरीके के लिए उपलब्ध पैरामीटर शामिल हैं.
- OAuth के दायरे, जो इस एपीआई के लिए उपलब्ध OAuth दायरों की सूची की पहचान करते हैं.
- इनलाइन दस्तावेज़, जिसमें स्कीमा, मेथड, पैरामीटर, और पैरामीटर की उपलब्ध वैल्यू के बारे में कम शब्दों में जानकारी दी जाती है.
सिंगल डायरेक्ट्री कलेक्शन, सिंगल एपीआई डायरेक्ट्री संसाधन का कॉन्सेप्ट है. साथ ही, इसमें ऐसे हर एपीआई के लिए डिस्कवरी दस्तावेज़ रिसॉर्स भी हैं जिन्हें इस्तेमाल किया जा सकता है.
एपीआई डायरेक्ट्री रिसॉर्स और डिस्कवरी दस्तावेज़ रिसॉर्स के बारे में ज़्यादा जानकारी, एपीआई इस्तेमाल करना और रेफ़रंस दस्तावेज़ में दी गई है.
कार्रवाइयां
जैसा कि नीचे दी गई टेबल में बताया गया है, आप Google API डिस्कवरी सेवा में, कलेक्शन और संसाधनों के लिए दो अलग-अलग तरीकों का इस्तेमाल कर सकते हैं.
| कार्रवाई | ब्यौरा | REST एचटीटीपी मैपिंग |
|---|---|---|
| list | काम करने वाले सभी एपीआई की सूची बनाता है. | डायरेक्ट्री रिसॉर्स यूआरआई पर GET. |
कॉल करने का तरीका
बाकी
काम करने वाले Google API डिस्कवरी सर्विस ऑपरेशंस सीधे REST एचटीटीपी GET कार्रवाई पर मैप करते हैं, जैसा कि ऑपरेशंस में बताया गया है.
Google API डिस्कवरी सर्विस यूआरआई के लिए खास फ़ॉर्मैट:
https://discovery.googleapis.com/discovery/v1/apis?parameters
जहां api, डिस्कवरी दस्तावेज़ के संसाधन का आइडेंटिफ़ायर होता है और version, एपीआई के खास वर्शन का आइडेंटिफ़ायर होता है. वहीं, _parameters_, क्वेरी पर लागू होने वाले पैरामीटर होते हैं. ज़्यादा जानकारी के लिए, रेफ़रंस दस्तावेज़ में क्वेरी पैरामीटर की खास जानकारी देखें
Google API डिस्कवरी सर्विस रेफ़रंस के दस्तावेज़ में, हर काम के लिए इस्तेमाल किए जाने वाले यूआरआई के पूरे सेट की जानकारी दी गई है.
Google API डिस्कवरी सर्विस में यह कैसे काम करता है, यहां इसके कुछ उदाहरण दिए गए हैं.
Google API डिस्कवरी सर्विस के साथ काम करने वाले सभी एपीआई की सूची बनाएं:
GET https://discovery.googleapis.com/discovery/v1/apis
इसे अभी API (एपीआई) एक्सप्लोरर में आज़माएं!
Google Cloud सेवा प्रबंधन एपीआई के वर्शन 1 के लिए, डिस्कवरी दस्तावेज़ पाएं:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1