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