अपने एपीआई (ओरिजनल वर्शन) पब्लिश करें

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. info

अपने पोर्टल पर एपीआई पब्लिश करें, ताकि ऐप्लिकेशन डेवलपर उनका इस्तेमाल कर सकें. इसके बारे में यहां बताया गया है.

एपीआई पब्लिश करने के बारे में खास जानकारी

अपने पोर्टल पर एपीआई पब्लिश करने की प्रोसेस में दो चरण शामिल हैं:

1. वह एपीआई प्रॉडक्ट चुनें जिसे आपको अपने पोर्टल पर पब्लिश करना है.
2. अपने OpenAPI स्पेसिफ़िकेशन के स्नैपशॉट से, एपीआई का संदर्भ दस्तावेज़ अपने-आप जनरेट करें. इससे ऐप्लिकेशन डेवलपर को आपके एपीआई के बारे में जानने में मदद मिलेगी. (स्नैपशॉट के बारे में ज़्यादा जानकारी के लिए, OpenAPI स्पेसिफ़िकेशन का स्नैपशॉट क्या होता है? लेख पढ़ें

अपने पोर्टल पर कोई एपीआई पब्लिश करने पर, आपके पोर्टल में ये अपडेट अपने-आप हो जाते हैं:

• आपके पोर्टल में एपीआई रेफ़रंस पेज जोड़ा जाता है
  एपीआई रेफ़रंस पेज, एपीआई रेफ़रंस दस्तावेज़ दिखाता है. इसे OpenAPI स्पेसिफ़िकेशन के स्नैपशॉट से अपने-आप जनरेट किया जाता है. डेवलपर, आपके एपीआई दस्तावेज़ की समीक्षा कर सकते हैं. साथ ही, एपीआई अनुरोध करने और आउटपुट देखने के लिए, इसे आज़माएं पर क्लिक कर सकते हैं.

  ध्यान दें: इस पेज के कॉन्टेंट में सीधे तौर पर बदलाव नहीं किया जा सकता. यह आपके पोर्टल में मौजूद पेजों की सूची में नहीं दिखता.

  

• एपीआई के संदर्भ पेज का लिंक, एपीआई पेज में जोड़ दिया गया है
  एपीआई पेज (सैंपल पोर्टल में शामिल) पर, आपके पोर्टल पर पब्लिश किए गए सभी एपीआई की सूची दी गई है. साथ ही, ज़्यादा जानकारी के लिए, एपीआई के संदर्भ दस्तावेज़ों के लिंक भी दिए गए हैं.

  ध्यान दें: इस पेज के कॉन्टेंट में सीधे तौर पर बदलाव नहीं किया जा सकता. यह आपके पोर्टल में मौजूद पेजों की सूची में नहीं दिखता.

  

OpenAPI स्पेसिफ़िकेशन का स्नैपशॉट क्या होता है?

हर OpenAPI स्पेसिफ़िकेशन, एपीआई की पूरी लाइफ़साइकल के दौरान भरोसेमंद सोर्स के तौर पर काम करता है. एक ही स्पेसिफ़िकेशन का इस्तेमाल, एपीआई की लाइफ़साइकल के हर चरण में किया जाता है. जैसे, डेवलपमेंट, पब्लिशिंग, और मॉनिटरिंग. किसी स्पेसिफ़िकेशन में बदलाव करते समय, आपको यह ध्यान रखना होगा कि बदलावों का असर, लाइफ़साइकल के अन्य चरणों के दौरान आपके एपीआई पर क्या पड़ेगा. इसके बारे में किसी स्पेसिफ़िकेशन में बदलाव करने पर क्या होता है? लेख में बताया गया है.

जब आप अपना एपीआई पब्लिश करते हैं, तो एपीआई का संदर्भ दस्तावेज़ जनरेट करने के लिए, OpenAPI स्पेसिफ़िकेशन का स्नैपशॉट लिया जाता है. यह स्नैपशॉट, स्पेसिफ़िकेशन स्टोर में मौजूद स्पेसिफ़िकेशन के किसी खास वर्शन को दिखाता है. अगर स्पेसिफ़िकेशन एडिटर का इस्तेमाल करके OpenAPI स्पेसिफ़िकेशन में बदलाव किया जाता है, तो एपीआई के संदर्भ दस्तावेज़ में नए बदलावों को दिखाने के लिए, स्पेसिफ़िकेशन का दूसरा स्नैपशॉट लिया जा सकता है.

अपनी एपीआई प्रॉक्सी में सीओआरएस की सुविधा जोड़ना

अपने एपीआई पब्लिश करने से पहले, आपको अपनी एपीआई प्रॉक्सी में सीओआरएस की सुविधा जोड़नी होगी. इससे क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को पूरा किया जा सकेगा.

सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) एक स्टैंडर्ड तरीका है. इसकी मदद से, किसी वेब पेज में एक्ज़ीक्यूट किए गए JavaScript XMLHttpRequest (XHR) कॉल, नॉन-ऑरिजिन डोमेन के रिसॉर्स के साथ इंटरैक्ट कर पाते हैं. सीओआरएस, एक ही ऑरिजिन से जुड़ी नीति को लागू करने का एक सामान्य तरीका है. इसे सभी ब्राउज़र लागू करते हैं. उदाहरण के लिए, अगर आपने अपने ब्राउज़र में चल रहे JavaScript कोड से Twitter API को XHR कॉल किया है, तो कॉल पूरा नहीं होगा. ऐसा इसलिए होता है, क्योंकि आपके ब्राउज़र को पेज दिखाने वाला डोमेन, Twitter API को पेज दिखाने वाले डोमेन से अलग होता है. सीओआरएस, इस समस्या का समाधान करता है. यह सर्वर को "ऑप्ट-इन" करने की अनुमति देता है, ताकि वे क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग की सुविधा दे सकें.

एपीआई पब्लिश करने से पहले, अपनी एपीआई प्रॉक्सी में सीओआरएस की सुविधा जोड़ने के बारे में जानकारी पाने के लिए, किसी एपीआई प्रॉक्सी में सीओआरएस की सुविधा जोड़ना लेख पढ़ें.

ध्यान दें: ज़्यादातर मॉडर्न ब्राउज़र, सीओआरएस लागू करते हैं. इस सुविधा के साथ काम करने वाले ब्राउज़र की पूरी सूची देखें. सीओआरएस के बारे में ज़्यादा जानकारी के लिए, क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग के लिए W3C का सुझाव देखें.

एपीआई पेज एक्सप्लोर करना

एपीआई पेज को ऐक्सेस करने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.

इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.

एपीआई की सूची दिखती है.

पिछली इमेज में हाइलाइट किए गए एपीआई पेज की मदद से, ये काम किए जा सकते हैं:

• अपने पोर्टल पर उपलब्ध एपीआई की जानकारी देखना
• अपने पोर्टल में कोई एपीआई जोड़ना
• एपीआई के रेफ़रंस दस्तावेज़ को अपडेट करने के लिए, एपीआई प्रॉडक्ट से जुड़े OpenAPI स्पेसिफ़िकेशन का स्नैपशॉट लें
• अपने पोर्टल पर किसी एपीआई को पब्लिश या अनपब्लिश करना
• अपने पोर्टल पर किसी एपीआई के लिए ऑडियंस मैनेज करना
• इससे जुड़े स्पेसिफ़िकेशन में बदलाव करें. इसके लिए, स्पेसिफ़िकेशन एडिटर का इस्तेमाल करके स्पेसिफ़िकेशन बनाना लेख पढ़ें
• अपने पोर्टल से किसी एपीआई को हटाना
• उन "अनाथ" एपीआई का तुरंत पता लगाएं जिनसे जुड़ा एपीआई प्रॉडक्ट, Edge से हटा दिया गया है. इसके बाद, एपीआई प्रॉडक्ट को फिर से बनाएं या अपने पोर्टल से एपीआई को मिटाएं

अपने पोर्टल में कोई एपीआई जोड़ना

ध्यान दें: अपने पोर्टल में ज़्यादा से ज़्यादा 100 एपीआई जोड़े जा सकते हैं.

अपने पोर्टल में कोई एपीआई जोड़ने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.
   इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.
3. + एपीआई पर क्लिक करें.
   इसके बाद, 'पोर्टल में एपीआई प्रॉडक्ट जोड़ें' डायलॉग बॉक्स दिखेगा.

4. डायलॉग बॉक्स में मौजूद API प्रॉडक्ट टैब पर जाकर, वह API प्रॉडक्ट चुनें जिसे आपको अपने पोर्टल में जोड़ना है.
   

5. आगे बढ़ें पर क्लिक करें.

6. स्नैपशॉट के लिए, इस्तेमाल किया जाने वाला सोर्स चुनें.
   अगर आपने OpenAPI स्पेसिफ़िकेशन का इस्तेमाल करके, एपीआई प्रॉडक्ट में शामिल एपीआई प्रॉक्सी बनाई है, तो ड्रॉप-डाउन सूची से स्पेसिफ़िकेशन चुनें.
   

   इसके अलावा, आपके पास ये विकल्प हैं:

   • कोई स्पेसिफ़िकेशन नहीं चुनें. इसके बाद, एपीआई पब्लिश होने के बाद स्पेसिफ़िकेशन जोड़ें. इसके बारे में स्पेसिफ़िकेशन का स्नैपशॉट लेना लेख में बताया गया है.
   • नया स्पेसिफ़िकेशन चुनने या अपलोड करने के लिए, कोई दूसरा स्पेसिफ़िकेशन चुनें पर क्लिक करें.

7. एपीआई को अपने पोर्टल पर पब्लिश करने के लिए, पब्लिश किया गया चेकबॉक्स चुनें. अगर आपको एपीआई पब्लिश नहीं करना है, तो पब्लिश किया गया से चुने का निशान हटाएं.
   अपने पोर्टल पर किसी एपीआई को पब्लिश या अनपब्लिश करना लेख में दिए गए तरीके का इस्तेमाल करके, बाद में इस सेटिंग को बदला जा सकता है.

8. ऑडियंस में जाकर, अपने एपीआई के लिए ऑडियंस मैनेज करने के लिए, इनमें से कोई एक विकल्प चुनें. इसके लिए, आपको इन्हें ऐक्सेस करने की अनुमति देनी होगी:

   • ऐसे उपयोगकर्ता जिन्होंने अपनी पहचान नहीं बताई है, ताकि सभी उपयोगकर्ता पेज देख सकें.
   • रजिस्टर किए गए उपयोगकर्ता को चुनें, ताकि सिर्फ़ रजिस्टर किए गए उपयोगकर्ता ही पेज देख सकें.

   अपने पोर्टल पर किसी एपीआई के लिए ऑडियंस मैनेज करना लेख में दिए गए तरीके से, इस सेटिंग को बाद में बदला जा सकता है.

9. पूरा करें पर क्लिक करें.

स्पेसिफ़िकेशन का स्नैपशॉट लें

एपीआई पब्लिश करने के बाद, किसी भी समय OpenAPI स्पेसिफ़िकेशन का नया स्नैपशॉट लिया जा सकता है. इससे, आपके पोर्टल पर पब्लिश किए गए एपीआई के संदर्भ दस्तावेज़ को अपडेट किया जा सकता है.

OpenAPI स्पेसिफ़िकेशन का स्नैपशॉट लेने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.
   इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.
3. कर्सर को उस एपीआई पर रखें जिसके लिए आपको कार्रवाइयाँ दिखाने के लिए स्नैपशॉट लेना है.

4. पर क्लिक करें.

   ध्यान दें: अगर आपने सोर्स स्पेसिफ़िकेशन चुना है और आपका स्नैपशॉट मौजूदा है, तो आपको एक मैसेज दिखेगा.

5. स्नैपशॉट सोर्स ड्रॉप-डाउन से कोई मौजूदा स्पेसिफ़िकेशन चुनें या कोई दूसरा स्पेसिफ़िकेशन चुनें को चुनकर, एपीआई के लिए दस्तावेज़ जनरेट करने के लिए कोई नया स्पेसिफ़िकेशन चुनें या अपलोड करें. इसके अलावा, मौजूदा स्पेसिफ़िकेशन हटाने के लिए, कोई स्पेसिफ़िकेशन नहीं को चुना जा सकता है.

6. स्नैपशॉट अपडेट करें पर क्लिक करें. अगर आपने 'कोई खास जानकारी नहीं' विकल्प चुना है, तो स्नैपशॉट हटाएं पर क्लिक करें.

एपीआई के संदर्भ से जुड़े दस्तावेज़, खास जानकारी से जनरेट होते हैं. इन्हें एपीआई के संदर्भ पेज पर जोड़ा जाता है.

अपने पोर्टल पर किसी एपीआई को पब्लिश या अनपब्लिश करना

अपने पोर्टल पर किसी एपीआई को पब्लिश या अनपब्लिश करने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.
   इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.
3. कर्सर को उस एपीआई पर रखें जिसे पब्लिश या अनपब्लिश करना है.
4. पर क्लिक करें.
5. अपने पोर्टल पर एपीआई पब्लिश करने के लिए, चालू है चेकबॉक्स को चुनें. एपीआई को अनपब्लिश करने के लिए, चालू है से चुने गए का निशान हटाएं.
6. सेव करें पर क्लिक करें.

अपने पोर्टल पर किसी एपीआई के लिए ऑडियंस को मैनेज करना

अपने पोर्टल पर, अपने एपीआई के लिए ऑडियंस को मैनेज करें. इसके लिए, इन्हें ऐक्सेस दें:

• सभी उपयोगकर्ता
• सिर्फ़ रजिस्टर किए गए उपयोगकर्ता

अपने पोर्टल पर किसी एपीआई के लिए ऑडियंस मैनेज करने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.
   इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.
3. कर्सर को उस एपीआई पर रखें जिसके लिए आपको ऑडियंस को मैनेज करना है, ताकि कार्रवाइयां दिख सकें.
4. पर क्लिक करें.
5. 'दर्शक' सेक्शन में जाकर, इनमें से कोई एक विकल्प चुनें:
   • Anonymous users को चुनें, ताकि सभी उपयोगकर्ता एपीआई प्रॉडक्ट देख सकें.
   • रजिस्टर किए गए उपयोगकर्ता, ताकि सिर्फ़ रजिस्टर किए गए उपयोगकर्ता ही एपीआई प्रॉडक्ट देख सकें.
6. सेव करें पर क्लिक करें.

अपने पोर्टल से किसी एपीआई को हटाना

अपने पोर्टल से किसी एपीआई को हटाने के लिए:

1. पब्लिश करें > पोर्टल को चुनें. इसके बाद, अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर, एपीआई पर क्लिक करें.
   इसके अलावा, सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में जाकर एपीआई को भी चुना जा सकता है.
3. कार्रवाइयों का मेन्यू दिखाने के लिए, सूची में मौजूद एपीआई पर कर्सर रखें.
4. पर क्लिक करें.

पब्लिश किए गए एपीआई से जुड़ी समस्याएं हल करना

'इसे आज़माएं' सुविधा का इस्तेमाल करते समय, अगर TypeError: Failed to fetch गड़बड़ी दिखती है, तो इसकी संभावित वजहें और समाधान देखें:

• मिला-जुला कॉन्टेंट से जुड़ी गड़बड़ियों के लिए, गड़बड़ी swagger-ui से जुड़ी किसी जानी-पहचानी समस्या की वजह से हो सकती है. इस समस्या को हल करने के लिए, यह पक्का करें कि आपने OpenAPI स्पेसिफ़िकेशन में schemes की परिभाषा में, एचटीटीपी से पहले एचटीटीपीएस के बारे में बताया हो. उदाहरण के लिए:

   schemes:
     - https
     - http
  

• सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) से जुड़ी पाबंदी की गड़बड़ियों के लिए, पक्का करें कि आपके एपीआई प्रॉक्सी के लिए सीओआरएस काम करता हो. सीओआरएस एक स्टैंडर्ड तरीका है. इससे क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को चालू किया जा सकता है. एपीआई प्रॉक्सी के लिए सीओआरएस की सुविधा जोड़ना लेख पढ़ें. यह भी पक्का करें कि आपके ब्राउज़र में CORS चालू हो.