Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
डेवलपर सेवाओं के पोर्टल में अपने एपीआई से जुड़े दस्तावेज़, जैसे कि 'इस्तेमाल करने का तरीका' गाइड और एपीआई के रेफ़रंस दस्तावेज़ जोड़ने के लिए, Drupal के "बेसिक पेज" कॉन्टेंट टाइप का इस्तेमाल करें. साथ ही, वीडियो, स्क्रीनकास्ट या कोड डाउनलोड जैसा कॉन्टेंट शामिल करें.
दस्तावेज़ पेज को कुछ शुरुआती एंट्री के साथ सेट अप किया जाता है. ये एंट्री अलग-अलग कैटगरी के हिसाब से व्यवस्थित की जाती हैं, जैसे कि "इस्तेमाल शुरू करना" और "ट्यूटोरियल". पेज पर आपको बदलाव करने की ज़रूरत है. इस तरह से अपने कॉन्टेंट में एंट्री जोड़ी जा सकती हैं और उन एंट्री को अपने हिसाब से व्यवस्थित किया जा सकता है.
दस्तावेज़ का होम पेज जोड़ना
डिफ़ॉल्ट रूप से, आपके डेवलपर पोर्टल के <siteURL>/document पर दस्तावेज़ों का होम पेज, होता है. डेवलपर पोर्टल के डिफ़ॉल्ट होम पेज पर, होम पेज पर सबसे ऊपर मौजूद बॉक्स में इस पेज का लिंक होता है:
डेवलपर पोर्टल मेन्यू के मुख्य मेन्यू में जाकर, इस पेज पर दस्तावेज़ का लिंक भी जोड़ा जा सकता है.
हालांकि, दस्तावेज़ों का होम पेज डिफ़ॉल्ट रूप से मौजूद नहीं होता. इसलिए, आपको सही यूआरएल पर डेवलपर पोर्टल में एक नया पेज बनाना होगा.
दस्तावेज़ का होम पेज अपने डेवलपर पोर्टल पर जोड़ने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, कॉन्टेंट > कॉन्टेंट जोड़ें > बुनियादी पेज चुनें.
- दस्तावेज़ का शीर्षक, जैसे कि दस्तावेज़ का होम पेज और पहले पेज का कॉन्टेंट डालें.
- खास जानकारी जोड़ने के लिए, खास जानकारी में बदलाव करें पर क्लिक करें.
- मुख्य टेक्स्ट सेक्शन के नीचे मौजूद, मेन्यू सेटिंग आइटम पर क्लिक करें.
- मेन्यू का लिंक दें को चुनें. इसके बाद, लिंक का टाइटल जोड़ें और पैरंट आइटम में
<मुख्य मेन्यू> चुनें.
इससे आपके दस्तावेज़ के होम पेज के मुख्य मेन्यू का लिंक जुड़ जाता है. - मुख्य हिस्से वाले सेक्शन के नीचे मौजूद, यूआरएल पाथ की सेटिंग वाले आइटम पर क्लिक करें.
- अपने-आप यूआरएल जनरेट करने वाले अन्य नाम से चुने हुए का निशान हटाएं. साथ ही, दस्तावेज़ में यूआरएल उपनाम सेट करें.
डिफ़ॉल्ट रूप से, पेज का यूआरएल <siteURL>/content/pageName होता है. यूआरएल उपनाम को सेट करके, पेज के लिए एक खास यूआरएल सेट किया जाता है. इस मामले में, यह <siteURL>/दस्तावेज़ है. - पेज को सेव करें.
अब आपको मेन्यू बार में, पेज का लिंक दिखेगा. साथ ही, होम पेज पर मौजूद बॉक्स में मौजूद लिंक अब काम करेगा.
एडमिन के तौर पर, आपको कॉन्टेंट मैनेज करने के बटन भी दिखेंगे. जैसे, 'देखें' और 'बदलाव करें'. गैर-एडमिन को वे दिखाई नहीं देंगे.
अपने दस्तावेज़ों में चाइल्ड पेज जोड़ना
अपने दस्तावेज़ में चाइल्ड पेज जोड़ने पर:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, कॉन्टेंट > कॉन्टेंट जोड़ें > बुनियादी पेज चुनें.
- पेज का टाइटल और कॉन्टेंट डालें.
- खास जानकारी जोड़ने के लिए, खास जानकारी में बदलाव करें पर क्लिक करें.
- मुख्य टेक्स्ट सेक्शन के नीचे मौजूद, मेन्यू सेटिंग आइटम पर क्लिक करें.
- मेन्यू का लिंक दें को चुनें. इसके बाद, दस्तावेज़ के होम पेज पर मौजूद मेन्यू आइटम चुनें.
इससे मौजूदा पेज को आपके दस्तावेज़ के होम पेज के मुख्य मेन्यू में जोड़ दिया जाएगा. - अब आपको दस्तावेज़ के होम पेज मेन्यू में, पेज का लिंक दिखेगा.
दस्तावेज़ वाले पेज में बदलाव करना
पेज में बदलाव करने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- डेवलपर पोर्टल में पेज पर जाएं.
Drupal के एडमिन मेन्यू में जाकर, कॉन्टेंट पर क्लिक करके भी, अपने सभी पेजों को सूची में जोड़ा जा सकता है और कोई एक पेज चुना जा सकता है. - पेज पर मौजूद बदलाव करें टैब को चुनें.
- मुख्य भाग सेक्शन के नीचे मौजूद 'टेक्स्ट फ़ॉर्मैट' ड्रॉप-डाउन मेन्यू में पूरा एचटीएमएल या फ़िल्टर किया गया एचटीएमएल चुनकर, एक विज़ुअल एडिटर खोलें.
आपको एडिटर में पेज का कॉन्टेंट दिखेगा. - पेज में ज़रूरत के हिसाब से बदलाव करें.
- 'सेव करें' पर क्लिक करें.
दस्तावेज़ों वाला कोई पेज दिखाना
किसी दस्तावेज़ का कॉन्टेंट दिखाने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में कॉन्टेंट चुनें.
- वह दस्तावेज़ चुनें जिसे आपको देखना है.
पेजों का क्रम
दस्तावेज़ के होम मेन्यू में जाकर, पेजों के क्रम और नेस्ट करने के लेवल को बदला जा सकता है.
दस्तावेज़ के होम मेन्यू में पेजों को फिर से क्रम में लगाने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, स्ट्रक्चर > मेन्यू > मुख्य मेन्यू चुनें.
- मेन्यू के हर आइटम के नाम के बाईं ओर एक आइकॉन होता है. अगर आपको आइकॉन नहीं दिखते, तो पंक्ति की मोटाई छिपाएं पर क्लिक करें.
- किसी आइटम को एक जगह से दूसरी जगह ले जाने के लिए, उस पर क्लिक करके उसे खींचें और नई जगह पर ले जाएं.
चाइल्ड आइटम के साथ किसी आइटम को खींचकर छोड़ने पर, बच्चे भी इधर-उधर ले जाते हैं.
- कॉन्फ़िगरेशन सेव करें पर क्लिक करें.
फ़ुटर पेजों में बदलाव करना
पोर्टल के फ़ुटर में Twitter, Facebook, और LinkedIn के लिए तीन सोशल आइकॉन हैं और इन यूआरएल के लिंक हैं:
- यूआरएल <siteURL>/privacy-policy के लिए निजता नीति
- यूआरएल <siteURL>/terms-use पर इस्तेमाल की शर्तें और इस्तेमाल
- <siteURL>/contact-us यूआरएल पर ले जाने वाले संपर्क पेज
अपना कॉन्टेंट जोड़ने के लिए, इन पेजों में बदलाव करें.
अगर ये पेज मौजूद नहीं हैं, तो उन्हें बनाएं:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, कॉन्टेंट > कॉन्टेंट जोड़ें > बुनियादी पेज चुनें.
- दस्तावेज़ का शीर्षक, जैसे कि निजता नीति और पेज का कॉन्टेंट डालें.
- खास जानकारी जोड़ने के लिए, खास जानकारी में बदलाव करें पर क्लिक करें.
- मुख्य हिस्से वाले सेक्शन के नीचे मौजूद, यूआरएल पाथ की सेटिंग वाले आइटम पर क्लिक करें.
- यूआरएल का उपनाम अपने-आप जनरेट करें को चुनें. इसके बाद, यूआरएल उपनाम को निजता-नीति पर
सेट करें.
डिफ़ॉल्ट रूप से, पेज का यूआरएल <siteURL>/content/pageName होता है. यूआरएल उपनाम सेट करके, आप पेज के लिए एक खास यूआरएल सेट करते हैं, इस मामले में <siteURL>/privacy-policy. - पेज को सेव करें.
- शर्तों, इस्तेमाल, और संपर्क करने के पेजों के लिए, इस प्रोसेस को दोहराएं.
अपने डेवलपर पोर्टल में फ़ुटर पेज के कॉन्टेंट में बदलाव करने के लिए, जैसे कि निजता नीति, इस्तेमाल की शर्तें या 'हमसे संपर्क करें' पेज:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- फ़ुटर में मौजूद पेज के लिंक पर क्लिक करके उस पेज पर जाएं. उदाहरण के लिए, निजता नीति के लिंक पर क्लिक करें.
- एडिटर खोलने के लिए, पेज में बदलाव करें टैब पर क्लिक करें.
- निजता नीति पेज के कॉन्टेंट में ज़रूरत के मुताबिक बदलाव करें.
- सेव करें पर क्लिक करें.
- शर्तों, इस्तेमाल, और संपर्क करने के पेजों के लिए, इस प्रोसेस को दोहराएं.
अपने डेवलपर पोर्टल में Twitter, Facebook, और LinkedIn जैसे सोशल आइकॉन में बदलाव करने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, स्ट्रक्चर > ब्लॉक चुनें.
- जब तक आपको पूरी साइट का डिफ़ॉल्ट फ़ुटर ब्लॉक न दिखे, तब तक ब्लॉक पेज को नीचे की ओर स्क्रोल करते रहें.
- पूरी साइट के डिफ़ॉल्ट फ़ुटर ब्लॉक के लिए, configure लिंक चुनें.
- कस्टम कॉन्टेंट वाले हिस्से में, सोशल मीडिया ऐप्लिकेशन के आइकॉन पर राइट क्लिक करें और पॉप-अप मेन्यू से,
लिंक में बदलाव करें चुनें. इसके अलावा, कस्टम कॉन्टेंट एरिया से आइकॉन को हटाने के लिए
उसे मिटाएं.
- अपने बदलावों को सेव करने के लिए, ब्लॉक करें को सेव करें को चुनें.
पोर्टल पेज में JavaScript जोड़ना
किसी भी पोर्टल पेज पर JavaScript जोड़ा जा सकता है. JavaScript जोड़ने का सबसे आसान तरीका यह है कि आप पेज में बदलाव करें. इसके बाद:
- टेक्स्ट फ़ॉर्मैट के तौर पर फ़ुल एचटीएमएल चुनें.
- पेज के एचटीएमएल सोर्स कोड में बदलाव करने के लिए, सोर्स बटन चुनें.
- पेज पर अपनी JavaScript जोड़ें. उदाहरण के लिए, पेज लोड होने पर अलर्ट बॉक्स पॉप अप करने के लिए,
यह कोड जोड़ें:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
JavaScript का इस्तेमाल करते समय इन बातों का ध्यान रखें:
- अगर आपको किसी JavaScript फ़ाइल का रेफ़रंस देना है, तो इसे नोड के सोर्स कोड में न करें. ऐसा करने से एक स्टैटिक लिंक बन जाता है. इसके बजाय PHP कोड का इस्तेमाल करें, ताकि आप डाइनैमिक लिंक बना सकें. इस तरह, अगर JavaScript फ़ाइल की जगह बदल जाती है, तो आपको उसे रेफ़र करने वाले सभी पोर्टल पेज अपडेट करने की ज़रूरत नहीं होगी.
- अगर आपको JavaScript फ़ाइल शामिल करनी है, तो उसे पोर्टल थीम में जोड़ें. इसके अलावा, अगर यह Drupal मॉड्यूल का हिस्सा है, तो इसे मॉड्यूल में जोड़ें.
- आप Drupal में JavaScript जोड़ने के लिए, Drupal drupal_add_js फ़ंक्शन का इस्तेमाल भी कर सकते हैं. ज़्यादा जानकारी के लिए, https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7
टूटे लिंक की जांच करना
बेहतर होगा कि आप अपने कॉन्टेंट में काम न करने वाले लिंक की जांच कर लें. डिफ़ॉल्ट रूप से, डेवलपर पोर्टल में काम न करने वाले लिंक के लिए अलग-अलग तरह के पेजों की जांच करने के लिए सेट अप किया गया है. उदाहरण के लिए, सामान्य पेजों, लेखों, ब्लॉग एंट्री, और फ़ोरम के विषयों में लिंक की जांच की जाती है.
लिंक की जांच में पेज टाइप जोड़ने या हटाने के लिए:
- Drupal के एडमिन मेन्यू में, मॉड्यूल चुनें और पक्का करें कि लिंक जांचने वाला मॉड्यूल चालू हो.
- Drupal के एडमिन मेन्यू में, कॉन्फ़िगरेशन > कॉन्टेंट ऑथरिंग > लिंक चेकर चुनें.
- उस कॉन्टेंट टाइप को कॉन्फ़िगर करें जिसे आपको काम न करने वाले लिंक का पता लगाने के लिए स्कैन करना है.
खोज को कॉन्फ़िगर किया जा रहा है
डेवलपर पोर्टल में पहले से मौजूद सर्च इंजन उपलब्ध होता है. इसे Apache Console ने लागू किया है, जो Apache Lucene सर्च लाइब्रेरी का इस्तेमाल करता है. यह खुद साइट के लिए सर्च इंजन है, जिसे लोग सभी पोर्टल पेजों के ऊपर दाएं कोने में मौजूद खोज बॉक्स की मदद से ऐक्सेस करते हैं.
Google जैसे बाहरी सर्च इंजन भी आपके पोर्टल को इंडेक्स कर सकते हैं. डेवलपर पोर्टल की मदद से, यह कंट्रोल किया जा सकता है कि बाहरी सर्च इंजन आपके पोर्टल को इंडेक्स कर सकते हैं या नहीं.
Apache Console को कॉन्फ़िगर करना
कॉन्टेंट के टाइप को इंडेक्स करने, इंडेक्स करने, उसे लागू करने, और कॉन्फ़िगरेशन से जुड़े दूसरे टास्क करने के लिए, Apache Console को कॉन्फ़िगर किया जा सकता है.
Apache Console को कॉन्फ़िगर करने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal के एडमिन मेन्यू में, कॉन्फ़िगरेशन > खोज और मेटाडेटा > Apache समाधान खोज चुनें.
- Apache Console को कॉन्फ़िगर करने के लिए, इस पेज का इस्तेमाल करें.
Google इंडेक्स की सुविधा बंद करना
अपने कॉन्टेंट को इंडेक्स करना और उसे सर्च इंजन पर उपलब्ध कराना भी अच्छा है. डिफ़ॉल्ट रूप से, आपका कॉन्टेंट Google इंडेक्सर से इंडेक्स किया जाता है. हालांकि, आपके पास Google इंडेक्स को बंद करने का विकल्प है. ऐसा तब किया जा सकता है, जब आपका डेवलपर पोर्टल सार्वजनिक इस्तेमाल के लिए तैयार न हो. साथ ही, आपको अपने कॉन्टेंट को सार्वजनिक तौर पर खोजने लायक नहीं बनाना हो.
Google की मदद से इंडेक्स करने की सुविधा बंद करने के लिए:
- अपने पोर्टल पर एडमिन या कॉन्टेंट बनाने के खास अधिकार वाले उपयोगकर्ता के तौर पर लॉग इन करें.
- Drupal एडमिन मेन्यू में मॉड्यूल चुनें.
- मेटाटैग मॉड्यूल को चालू करें.
- कॉन्फ़िगरेशन सेव करें पर क्लिक करें.
- Drupal के एडमिन मेन्यू में, कॉन्फ़िगरेशन > खोज और मेटाडेटा > मेटाटैग चुनें.
- ग्लोबल टाइप के लिए, बदलाव करें ऑपरेशन चुनें.
- बेहतर सेक्शन को खोलने के लिए उस पर क्लिक करें.
- सर्च इंजन को इस पेज को इंडेक्स करने से रोकने के लिए, चेकबॉक्स को चुनें.
- सेव करें पर क्लिक करें.
ध्यान दें कि ग्लोबल पेज के बेहतर सेक्शन में, सर्च-इंजन से जुड़े अन्य विकल्प मौजूद हैं. उदाहरण के लिए, आपके पास चेकबॉक्स पर सही का निशान लगाने का विकल्प होता है. इससे, सर्च इंजन को किसी पेज पर मौजूद लिंक को फ़ॉलो करने से रोका जा सकता है. इनमें से एक या ज़्यादा चेकबॉक्स पर सही का निशान लगाएं.
ऐप्लिकेशन रजिस्टर करने का तरीका बताने वाला दस्तावेज़
यह ज़रूरी है कि आपके दस्तावेज़ में इस बारे में निर्देश शामिल हों कि आपके डेवलपर पोर्टल की मदद से डेवलपर अपने ऐप्लिकेशन कैसे रजिस्टर कर सकते हैं. शुरुआत में, इन निर्देशों का इस्तेमाल किया जा सकता है — इन निर्देशों में डिफ़ॉल्ट डेवलपर पोर्टल से ऐप्लिकेशन रजिस्टर करने का तरीका बताया गया है.
डेवलपर आपके पोर्टल पर ऐप्लिकेशन कैसे रजिस्टर कर सकते हैं, यह कॉन्फ़िगर करने के लिए ऐप्लिकेशन रजिस्ट्रेशन कॉन्फ़िगर करना देखें. अगर ऐप्लिकेशन रजिस्ट्रेशन प्रोसेस में बदलाव किया जाता है, तो नीचे दिए गए उदाहरण के निर्देशों के मुताबिक बदलाव करें.
डिफ़ॉल्ट डेवलपर पोर्टल का इस्तेमाल करके, किसी ऐप्लिकेशन को रजिस्टर करने के लिए:
- लॉगिन मेन्यू में, अपने उपयोगकर्ता नाम के नीचे, मेरे ऐप्लिकेशन चुनें.
- नया ऐप्लिकेशन आइकॉन जोड़ें (+) पर क्लिक करें.
- ऐप्लिकेशन जोड़ें पेज में सही मान डालें:
ऐप्लिकेशन का नाम अपने ऐप्लिकेशन के लिए एक खास नाम दें. कॉलबैक यूआरएल अगर ज़रूरी हो, तो वह कॉलबैक यूआरएल दें जिस पर OAuth कॉल वापस आना चाहिए.
डिफ़ॉल्ट रूप से, यह वैल्यू ज़रूरी होती है भले ही आपके एपीआई OAuth का इस्तेमाल न करते हों. अगर आपके एपीआई, OAuth का इस्तेमाल नहीं करते हैं, तो my.site.com जैसी डमी वैल्यू डालें.
प्रॉडक्ट एक या उससे ज़्यादा एपीआई प्रॉडक्ट चुनें. - ऐप्लिकेशन को रजिस्टर करने और ऐप्लिकेशन के लिए एपीआई पासकोड जनरेट करने के लिए, ऐप्लिकेशन बनाएं पर क्लिक करें.