इंस्टॉल की जांच करें में बताई गई इंस्टॉलेशन टेस्ट स्क्रिप्ट को इंस्टॉल और चलाने पर, 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" की वैल्यू में, SmartDocs में जोड़े गए OpenAPI स्पेसिफ़िकेशन में शामिल सभी होस्ट शामिल होने चाहिए. उदाहरण के लिए, अगर आपके पास कोई OpenAPI स्पेसिफ़िकेशन है जो
mocktarget.apigee.netको कॉल करता है, तो आपको "allowed_hosts" वैल्यू मेंmocktarget.apigee.netजोड़ना होगा. अगर होस्ट नहीं है KVM में शामिल किए गए SmartDocs के जवाब, कॉन्टेंट के साथ400 Bad RequestहोंगेBad Request-Hostname not permittedका पेलोड.
ध्यान दें: अगर इस KVM को जोड़कर कॉन्फ़िगर नहीं किया जाता है, तो प्रॉक्सी, व्हाइटलिस्टिंग लागू नहीं करेगी. यह
आपके होस्ट और आईपी पतों को बिना अनुमति के ऐक्सेस कर सकता है. केवल इसके होस्टनाम और IP पते
SmartDocs के साथ दस्तावेज़ किए गए एपीआई एंडपॉइंट को "allowed_hosts" में शामिल किया जाना चाहिए वैल्यू.