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

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

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

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

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

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

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

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

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

  

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

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

  

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

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

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

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

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

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

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

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

एपीआई पेज के बारे में जानें

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

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

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

इसके बाद, एपीआई की सूची दिखेगी.

जैसा कि पिछले चित्र में हाइलाइट किया गया है, API पेज आपको निम्न करने में सक्षम बनाता है:

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

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

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

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

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

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

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. दर्शक सेक्शन में जाकर, इनमें से कोई विकल्प चुनें:
   • पहचान छिपाने वाले उपयोगकर्ता चुनें, ताकि सभी उपयोगकर्ताओं को एपीआई का प्रॉडक्ट देखने की अनुमति मिल जाए.
   • रजिस्टर कर चुके उपयोगकर्ता, ताकि रजिस्टर किए गए उपयोगकर्ता ही एपीआई का प्रॉडक्ट देख सकें.
6. सेव करें पर क्लिक करें.

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

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

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

पब्लिश किए गए एपीआई की समस्याओं को हल करना

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

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

   schemes:
     - https
     - http
  

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