Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
एपीआई सेवा देने वाली कंपनी के तौर पर, आपको अपने एपीआई को एक्सपोज़ करने, डेवलपर को अपने एपीआई के बारे में जानकारी देने, डेवलपर को साइन अप करने, और डेवलपर को ऐप्लिकेशन रजिस्टर करने की सुविधा देने का तरीका चाहिए. Apigee Edge, आपको डेवलपर सेवाओं का एक पोर्टल उपलब्ध कराता है. इसका इस्तेमाल करके, अपनी पसंद के मुताबिक वेबसाइट बनाई और लॉन्च की जा सकती है. इससे, डेवलपर कम्यूनिटी को ये सेवाएं दी जा सकती हैं. डेवलपर पोर्टल के बारे में ज़्यादा जानने के लिए, देखें डेवलपर पोर्टल क्या है?
नीचे दिए गए सेक्शन में, डेवलपर पोर्टल से जुड़ी समस्याओं को हल करने से पहले, आपको समझने वाले मुख्य कॉन्सेप्ट के बारे में बताया गया है.
SmartDocs के काम करने का तरीका
आपके एपीआई के बारे में बताने वाले OpenAPI (JSON या YAML) या WADL स्पेसिफ़िकेशन को, स्मार्ट दस्तावेज़ों में इंपोर्ट किया जा सकता है. साथ ही, इसका इस्तेमाल अपने पोर्टल पर एपीआई के रेफ़रंस दस्तावेज़ को पब्लिश करने के लिए किया जा सकता है. एपीआई रेफ़रंस दस्तावेज़, आपके पोर्टल पर एपीआई टैब में अपने-आप दिखता है. डेवलपर, पोर्टल की मदद से एपीआई दस्तावेज़ खोज सकते हैं और लाइव एपीआई अनुरोध कर सकते हैं. एपीआई अनुरोध, ब्राउज़र से शुरू होते हैं. इसलिए, उन्हें पूरा करने के लिए सीओआरएस (क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग) की ज़रूरत होती है. सीओआरएस की सुविधा, Edge पर "smartdocs" प्रॉक्सी की मदद से मिलती है. यह प्रॉक्सी, "VALIDATE" संगठन में मौजूद होती है. यह प्रॉक्सी, टारगेट किए गए एंडपॉइंट पर सभी SmartDocs अनुरोधों के लिए प्रॉक्सी के तौर पर काम करती है. SmartDocs इंस्टॉल करने पर, "smartdocs" प्रोक्सी बन जाता है.
उदाहरण के लिए:
कॉन्फ़िगरेशन -> SmartDocs -> SmartDocs प्रॉक्सी यूआरएल पर, SmartDocs प्रॉक्सी का यूआरएल, कॉन्फ़िगर की जा सकने वाली प्रॉपर्टी के तौर पर दिखता है. अगर आपका एपीआई किसी निजी नेटवर्क पर है और आपके पोर्टल से SmartDocs का इस्तेमाल करके किए गए लाइव एपीआई अनुरोध काम नहीं कर रहे हैं, तो आपको इस यूआरएल में बदलाव करना पड़ सकता है.
डेवलपर पोर्टल, Edge के साथ कैसे काम करता है
डेवलपर पोर्टल, Edge से दिखाई जाने वाली ज़्यादातर जानकारी को सेव और फिर से पाता है. इसमें स्मार्ट दस्तावेज़, डेवलपर, प्रॉडक्ट, और डेवलपर ऐप्लिकेशन शामिल हैं. Edge संगठन की जानकारी और डेवलपर एडमिन के क्रेडेंशियल को कॉन्फ़िगर करने के लिए, मेन्यू कमांड कॉन्फ़िगरेशन -> Devportal का इस्तेमाल करें.
ज़्यादा जानकारी के लिए, Portal और Edge के बीच कम्यूनिकेट करना लेख पढ़ें.