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