इंस्टॉलेशन टेस्ट स्क्रिप्ट इंस्टॉल करने और चलाने पर SmartDocs अपने-आप इंस्टॉल हो जाता है इंस्टॉल की जांच करना में बताया गया है. परीक्षण चलाने के भाग के रूप में तो आपको इन निर्देशों का पालन करना होता है:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFileजहां configFile वही कॉन्फ़िगरेशन फ़ाइल है जिसका इस्तेमाल आपने Edge इंस्टॉल करने के लिए किया था. ज़्यादा जानकारी के लिए, किसी नोड पर Edge कॉम्पोनेंट इंस्टॉल करना देखें.
इस निर्देश की मदद से, टेस्ट के लिए SmartDocs इंस्टॉल किया जाता है.
इंस्टॉल करने की प्रोसेस पूरी करने के लिए:
smartdocs.zipफ़ाइल के सही होने की पुष्टि करके, यह जांच करें कि SmartDocs को इंस्टॉल किया गया है या नहीं जो इस डायरेक्ट्री में मौजूद है:/opt/apigee/apigee-validate/bundles/
या मैनेजमेंट सर्वर नोड पर नीचे दिया गया एपीआई कॉल चलाएं:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
अगर SmartDocs इंस्टॉल किया गया है, तो इस निर्देश से ये नतीजे मिलेंगे:
[ "smartdocs", "passthrough" ]
- Edge के यूज़र इंटरफ़ेस (यूआई) से, “smartdocs_whitelist” नाम की KVM बनाएं और उसे अपडेट करें. इसकी जानकारी यहां दी गई है.
केवीएम को ऐसे संगठन और एनवायरमेंट में बनाया जाना चाहिए जहां SmartDocs प्रॉक्सी
डिप्लॉय किए जा रहे हैं.
ध्यान दें: पक्का करें कि एन्क्रिप्ट (सुरक्षित) किए गए के बॉक्स पर सही का निशान न लगा हो.
- “is_whitelist_Configure” नाम की कुंजी जोड़ें, जहां वैल्यू “YES” हो.
- “allowed_hosts” नाम की दूसरी कुंजी जोड़ें. इसमें वैल्यू, स्पेस से अलग किए गए होस्टनेम या आईपी पते हों
SmartDocs से कॉल किया गया. "allowed_hosts" की वैल्यू इसमें OpenAPI की खास जानकारी वाले किसी भी होस्ट को शामिल किया जाना चाहिए
SmartDocs में जोड़ा गया. उदाहरण के लिए, अगर आपके पास OpenAPI का ऐसा स्पेसिफ़िकेशन है जो
mocktarget.apigee.netको कॉल करता है, आपकोmocktarget.apigee.netको "allowed_hosts" में जोड़ना होगा वैल्यू. अगर होस्ट नहीं है KVM में शामिल किए गए SmartDocs के जवाब, कॉन्टेंट के साथ400 Bad RequestहोंगेBad Request-Hostname not permittedका पेलोड.
ध्यान दें: अगर इस केवीएम को जोड़ा और कॉन्फ़िगर नहीं किया जाता है, तो प्रॉक्सी अनुमति देने की सुविधा लागू नहीं होगी. यह
आपके होस्ट और आईपी पतों को बिना अनुमति के ऐक्सेस कर सकता है. केवल इसके होस्टनाम और IP पते
SmartDocs के साथ दस्तावेज़ किए गए एपीआई एंडपॉइंट को "allowed_hosts" में शामिल किया जाना चाहिए वैल्यू.