يتم تثبيت Smart Docs تلقائيًا عند تثبيت النصوص البرمجية لاختبار التثبيت وتشغيلها كما هو موضح في اختبار التثبيت. كجزء من إجراء الاختبار البرامج النصية، فأنت تقوم بتشغيل الأوامر التالية:
/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 على عقدة لمعرفة المزيد.
يعمل هذا الأمر على تثبيت تطبيق Smart Docs كجزء من إجراء الاختبارات.
لإكمال عملية التثبيت:
يمكنك اختبار تثبيت تطبيق Smart Docs من خلال التأكُّد من أنه تم تثبيت ملف
smartdocs.zip. موجودة في الدليل التالي:/opt/apigee/apigee-validate/bundles/
أو تشغيل طلب البيانات التالي من واجهة برمجة التطبيقات على عقدة خادم الإدارة:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
من المفترض أن يعرض هذا الأمر ما يلي في حال تثبيت Smart Docs:
[ "smartdocs", "passthrough" ]
- من واجهة مستخدم Edge، قم بإنشاء وتحديث KVM باسم "smartdocs_whitelist"، كما هو موضح في الشكل أدناه.
يجب إنشاء KVM في المؤسسة والبيئة حيث يتم إنشاء الخادم الوكيل Smart Docs
المنشورة حاليًا.
ملاحظة: تأكَّد من عدم وضع علامة في المربّع بجانب Encrypted.
- أضِف مفتاحًا باسم "is_whitelist_Configure"، حيث تكون القيمة هي "YES (نعم)".
- أضِف مفتاحًا ثانيًا باسم "allowed_hosts"، حيث تكون القيم عبارة عن أسماء مضيفين أو عناوين IP مفصولة بمسافة
استدعيتهما من Smart Docs. قيمة "allowed_hosts" تضمين أي مضيفين مدرجين في مواصفات OpenAPI
تمت إضافتها إلى Smart Docs. على سبيل المثال، إذا كانت لديك مواصفات OpenAPI التي تستدعي
mocktarget.apigee.net، عليك إضافةmocktarget.apigee.netإلى "allowed_hosts". إذا لم يكن المضيف في KVM، سيكون استجابة Smartالمستندات400 Bad Requestمع محتوى حمولةBad Request-Hostname not permitted.
ملاحظة: في حالة عدم إضافة KVM وتهيئته، لن يفرض الخادم الوكيل الإضافة إلى القائمة البيضاء. هذا النمط
إلى الدخول غير المصرح به إلى المضيفات وعناوين IP. أسماء المضيفين وعناوين IP فقط
يجب تضمين نقاط نهاية واجهة برمجة التطبيقات الموثقة باستخدام Smartالمستندات في الحقل "allowed_hosts" القيم.