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