आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इस पेज पर जाएं
Apigee X दस्तावेज़. जानकारी
नीचे दिए गए सेक्शन में बताए गए तरीके से, अपने पोर्टल पर एपीआई पब्लिश करें, ताकि ऐप्लिकेशन डेवलपर उन्हें इस्तेमाल करने के लिए उपलब्ध करा सकें.
एपीआई पब्लिश करने की सुविधा के बारे में खास जानकारी
अपने पोर्टल पर एपीआई पब्लिश करने की प्रोसेस दो चरणों में होती है:
- वह एपीआई प्रॉडक्ट चुनें जिसे आपको अपने पोर्टल पर पब्लिश करना है.
- आपके OpenAPI स्पेसिफ़िकेशन के स्नैपशॉट से एपीआई रेफ़रंस दस्तावेज़ अपने-आप जनरेट करें, ताकि ऐप्लिकेशन डेवलपर आपके एपीआई के बारे में जान सकें. (स्नैपशॉट के बारे में ज़्यादा जानकारी के लिए, OpenAPI की खास जानकारी का स्नैपशॉट क्या होता है?
जब पोर्टल पर कोई एपीआई पब्लिश किया जाता है, तो आपके पोर्टल पर अपने-आप ये अपडेट होते हैं:
आपके पोर्टल में एक एपीआई रेफ़रंस पेज जोड़ा गया है
एपीआई रेफ़रंस पेज, उस एपीआई रेफ़रंस दस्तावेज़ को दिखाता है जिसे आपने OpenAPI स्पेसिफ़िकेशन के स्नैपशॉट से अपने-आप जनरेट किया है. डेवलपर आपके एपीआई दस्तावेज़ की समीक्षा कर सकते हैं. इसके बाद, एपीआई का अनुरोध करने और आउटपुट देखने के लिए, इसे आज़माएं पर क्लिक कर सकते हैं.ध्यान दें: आप इस पेज के कॉन्टेंट में सीधे बदलाव नहीं कर सकते; यह आपके पोर्टल के पेजों की सूची में नहीं दिखती है.
एपीआई पेज पर, एपीआई के रेफ़रंस पेज का एक लिंक जोड़ा गया है
एपीआई पेज (सैंपल पोर्टल के साथ) में, आपके पोर्टल पर पब्लिश किए गए सभी एपीआई की सूची होती है. साथ ही, ज़्यादा जानकारी के लिए, एपीआई से जुड़े दस्तावेज़ के लिंक भी दिए जाते हैं.ध्यान दें: आप इस पेज के कॉन्टेंट में सीधे बदलाव नहीं कर सकते; यह आपके पोर्टल के पेजों की सूची में नहीं दिखती है.
OpenAPI की खास बातों का स्नैपशॉट क्या है?
हर OpenAPI स्पेसिफ़िकेशन, किसी एपीआई के लाइफ़साइकल के दौरान सटीक सेवा देने के लिए काम करता है. डेवलपमेंट से लेकर पब्लिश करने और मॉनिटर करने तक, एपीआई के लाइफ़साइकल के हर चरण में एक ही स्पेसिफ़िकेशन का इस्तेमाल किया जाता है. किसी स्पेसिफ़िकेशन में बदलाव करते समय, आपको यह पता होना चाहिए कि लाइफ़साइकल के अन्य चरणों से, आपके एपीआई पर बदलावों का क्या असर पड़ता है. इसके बारे में, किसी स्पेसिफ़िकेशन में बदलाव करने पर क्या होगा? में बताया गया है
अपना एपीआई पब्लिश करने के दौरान, एपीआई रेफ़रंस दस्तावेज़ जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का एक स्नैपशॉट लिया जाता है. वह स्नैपशॉट, स्पेक्ट स्टोर में स्पेसिफ़िकेशन का खास वर्शन दिखाता है. अगर आपको खास जानकारी में बदलाव करने वाले एडिटर का इस्तेमाल करके, OpenAPI के स्पेसिफ़िकेशन में बदलाव करना है, तो इस स्पेसिफ़िकेशन का एक और स्नैपशॉट लेने का फ़ैसला लिया जा सकता है. इससे एपीआई के रेफ़रंस दस्तावेज़ में हुए नए बदलावों के बारे में जानकारी मिलेगी.
आपकी एपीआई प्रॉक्सी में सीओआरएस की सुविधा जोड़ी जा रही है
अपने एपीआई पब्लिश करने से पहले, आपको अपनी एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ना होगा, ताकि क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को पूरा किया जा सके.
सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) एक स्टैंडर्ड तरीका है. यह किसी वेब पेज में एक्ज़ीक्यूट किए गए JavaScript XMLHttpRequest (XHR) कॉल को बिना ऑरिजिन वाले डोमेन के संसाधनों से इंटरैक्ट करने की अनुमति देता है. सीओआरएस, एक ही ऑरिजिन से जुड़ी नीति का आम तौर पर लागू किया गया समाधान है. इसे सभी ब्राउज़र पर लागू किया जाता है. उदाहरण के लिए, अगर ब्राउज़र में लागू किए जा रहे JavaScript कोड से Twitter API को XHR कॉल किया जाता है, तो कॉल नहीं हो पाएगा. ऐसा इसलिए है, क्योंकि आपके ब्राउज़र पर पेज को उपलब्ध कराने वाला डोमेन, Twitter API की सेवा देने वाले डोमेन से मेल नहीं खाता. सीओआरएस, सर्वर को "ऑप्ट-इन" करने की अनुमति देकर इस समस्या का समाधान उपलब्ध कराता है अगर वे क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग उपलब्ध कराना चाहते हैं.
एपीआई पब्लिश करने से पहले, अपनी एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ने के बारे में जानकारी पाने के लिए, एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ना लेख पढ़ें.
ध्यान दें: ज़्यादातर मॉडर्न ब्राउज़र सीओआरएस को लागू करते हैं. इस्तेमाल किए जा सकने वाले ब्राउज़र की पूरी सूची देखें. सीओआरएस के बारे में ज़्यादा जानकारी पाने के लिए, क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग W3C सुझाव देखें.
एपीआई पेज को एक्सप्लोर करें
एपीआई पेज को ऐक्सेस करने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में, एपीआई चुनने का भी विकल्प है.
एपीआई की सूची दिखेगी.
जैसा कि पिछले डायग्राम में बताया गया है, एपीआई पेज की मदद से ये काम किए जा सकते हैं:
- अपने पोर्टल पर उपलब्ध एपीआई की जानकारी देखें
- अपने पोर्टल में एपीआई जोड़ना
- एपीआई रेफ़रंस दस्तावेज़ को अपडेट करने के लिए, किसी एपीआई प्रॉडक्ट से जुड़े OpenAPI की खास बातों का स्नैपशॉट लें
- अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करना
- अपने पोर्टल पर एपीआई के लिए ऑडियंस मैनेज करना
- इससे जुड़ी जानकारी में बदलाव करना. खास जानकारी वाले एडिटर का इस्तेमाल करके खास जानकारी बनाना लेख पढ़ें
- अपने पोर्टल से एपीआई हटाना
- "ऑर्फ़्ड" की तुरंत पहचान करें ऐसे एपीआई जिनसे जुड़े एपीआई प्रॉडक्ट को Edge से हटा दिया गया है और वह एपीआई प्रॉडक्ट फिर से बनाता है या अपने पोर्टल से एपीआई को मिटाता है
अपने पोर्टल में एपीआई जोड़ें
ध्यान दें: अपने पोर्टल में ज़्यादा से ज़्यादा 100 एपीआई जोड़े जा सकते हैं.
अपने पोर्टल में एपीआई जोड़ने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई चुनने का विकल्प भी है. - + एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस इमेज में दिखाया गया है कि 'पोर्टल में एपीआई प्रॉडक्ट जोड़ें' डायलॉग बॉक्स दिखाया जा रहा है. डायलॉग बॉक्स में 'एपीआई प्रॉडक्ट' टैब पर, वह एपीआई प्रॉडक्ट चुनें जिसे आपको अपने पोर्टल में जोड़ना है.
आगे बढ़ें पर क्लिक करें.
स्नैपशॉट के लिए इस्तेमाल करने के लिए सोर्स चुनें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है अगर आपने OpenAPI प्रॉडक्ट की खास बातों का इस्तेमाल करके, एपीआई प्रॉडक्ट में शामिल एपीआई प्रॉक्सी बनाया है, तो ड्रॉप-डाउन सूची से जानकारी चुनें.
इसके अलावा, आपके पास ये विकल्प भी हैं:
- कोई शर्त नहीं. एपीआई के पब्लिश होने के बाद, इसे बाद में जोड़ें. इसके बारे में, खास जानकारी का स्नैपशॉट लेना में बताया गया है.
- नई जानकारी चुनने या अपलोड करने के लिए, कोई दूसरी शर्त चुनें.
अपने पोर्टल पर एपीआई को पब्लिश करने के लिए, पब्लिश किया गया चेकबॉक्स चुनें. अगर आप एपीआई को पब्लिश करने के लिए तैयार नहीं हैं, तो पब्लिश किया गया से चुने हुए का निशान हटाएं.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है बाद में सेटिंग में बदलाव किया जा सकता है. इसके बारे में, अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करना में बताया गया है.ऑडियंस सेक्शन में जाकर, अपने एपीआई के लिए ऑडियंस को मैनेज करने के लिए इनमें से कोई एक विकल्प चुनें. इसके लिए, इन विकल्पों का ऐक्सेस दें:
- पहचान छिपाकर फ़ॉलो किए जाने वाले उपयोगकर्ता, ताकि सभी उपयोगकर्ता पेज देख सकें.
- रजिस्टर कर चुके उपयोगकर्ता सिर्फ़ रजिस्टर्ड उपयोगकर्ताओं को पेज देखने की अनुमति दें.
सेटिंग को बाद में भी बदला जा सकता है. इसके लिए, अपने पोर्टल पर एपीआई के लिए ऑडियंस मैनेज करना सेक्शन में बताया गया तरीका अपनाएं.
पूरा करें पर क्लिक करें.
स्पेसिफ़िकेशन का स्नैपशॉट लें
अपना एपीआई पब्लिश करने के बाद, अपने पोर्टल पर पब्लिश किए गए एपीआई रेफ़रंस दस्तावेज़ को अपडेट करने के लिए, किसी भी समय OpenAPI स्पेसिफ़िकेशन का एक नया स्नैपशॉट लिया जा सकता है.
OpenAPI की खास बातों का स्नैपशॉट लेने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई चुनने का विकल्प भी है. - कर्सर को उस एपीआई पर रखें जिसकी कार्रवाइयां दिखाने के लिए, आपको स्नैपशॉट लेना है.
पर क्लिक करें. ध्यान दें: अगर आपका स्नैपशॉट, चुनी गई सोर्स स्पेसिफ़िकेशन के साथ हाल ही का है, तो आपको मैसेज दिखेगा.
स्नैपशॉट सोर्स के ड्रॉप-डाउन से कोई मौजूदा स्पेसिफ़िकेशन चुनें या एपीआई के लिए दस्तावेज़ जनरेट करने के मकसद से कोई नई स्पेसिफ़िकेशन चुनने या अपलोड करने के लिए, कोई अन्य जानकारी चुनें को चुनें. इसके अलावा, मौजूदा स्पेसिफ़िकेशन को हटाने के लिए, कोई खास जानकारी नहीं को चुनें.
स्नैपशॉट अपडेट करें पर क्लिक करें (या अगर आपने कोई खास जानकारी नहीं चुना है, तो स्नैपशॉट हटाएं पर क्लिक करें).
एपीआई का रेफ़रंस डॉक्यूमेंटेशन, खास जानकारी से जनरेट किया जाता है और उसे एपीआई रेफ़रंस पेज में जोड़ा जाता है.
अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करना
अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई चुनने का विकल्प भी है. - कर्सर को उस एपीआई पर रखें जिसे पब्लिश या अनपब्लिश करना है.
पर क्लिक करें. - एपीआई को अपने पोर्टल पर पब्लिश करने के लिए, चालू है चेकबॉक्स को चुनें. एपीआई को अनपब्लिश करने के लिए, चालू है से चुने हुए का निशान हटाएं.
- सेव करें पर क्लिक करें.
अपने पोर्टल पर एपीआई के लिए ऑडियंस को मैनेज करें
अपने पोर्टल पर एपीआई के लिए ऑडियंस को मैनेज करें. इसके लिए, इन चीज़ों का ऐक्सेस दें:
- सभी उपयोगकर्ता
- सिर्फ़ रजिस्टर कर चुके उपयोगकर्ता
अपने पोर्टल पर किसी एपीआई के लिए ऑडियंस को मैनेज करने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई चुनने का विकल्प भी है. - कर्सर को उस एपीआई पर रखें जिसके लिए आपको कार्रवाइयां दिखाने के लिए, ऑडियंस को मैनेज करना है.
- पर क्लिक करें.
- 'दर्शक' सेक्शन में जाकर, इनमें से कोई एक विकल्प चुनें:
- पहचान छिपाने वाले उपयोगकर्ता, ताकि सभी उपयोगकर्ता एपीआई प्रॉडक्ट देख सकें.
- रजिस्टर कर चुके उपयोगकर्ता: सिर्फ़ रजिस्टर कर चुके उपयोगकर्ता, एपीआई प्रॉडक्ट देख सकें.
- सेव करें पर क्लिक करें.
अपने पोर्टल से कोई एपीआई हटाना
अपने पोर्टल से किसी एपीआई को हटाने के लिए:
- पब्लिश करें > को चुनें पोर्टल पर जाएं और अपना पोर्टल चुनें.
- पोर्टल के होम पेज पर एपीआई पर क्लिक करें.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई चुनने का विकल्प भी है. - ऐक्शन मेन्यू देखने के लिए, सूची में मौजूद एपीआई पर अपना कर्सर रखें.
पर क्लिक करें.
पब्लिश किए गए एपीआई से जुड़ी समस्याओं को हल करना
अगर आपको 'इसे आज़माएं' का इस्तेमाल करते समय TypeError: Failed to fetch गड़बड़ी मिलती है, तो इसकी ये संभावित वजहें और समाधान देखें:
मिले-जुले कॉन्टेंट की गड़बड़ियों के लिए, गड़बड़ी स्वैगर-यूज़र इंटरफ़ेस (यूआई) से जुड़ी किसी ऐसी समस्या की वजह से हो सकती है जिसके बारे में पहले से जानकारी है. इसका एक संभावित समाधान यह है कि आप अपने OpenAPI स्पेसिफ़िकेशन में,
schemesपरिभाषा में एचटीटीपी से पहले एचटीटीपीएस तय करें. उदाहरण के लिए:schemes: - https - httpसीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) पर पाबंदी से जुड़ी गड़बड़ियों के मामले में, पक्का करें कि सीओआरएस आपके एपीआई प्रॉक्सी के साथ काम करती हो. सीओआरएस एक स्टैंडर्ड तरीका है, जो क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को चालू करता है. एपीआई प्रॉक्सी के लिए सीओआरएस सहायता जोड़ना लेख पढ़ें. पक्का करें कि आपके ब्राउज़र में सीओआरएस भी चालू हो.