يتم تثبيت 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 كجزء من إجراء الاختبارات.
لإكمال عملية التثبيت:
يمكنك اختبار تثبيت تطبيق 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، أنشئ قائمة بيضاء للمسؤولين عن إدارة الخدمات وعدِّلها باسم "smartdocs_whitelist"، كما هو موضّح في الشكل أدناه.
يجب إنشاء KVM في المؤسسة والبيئة التي يتم فيها حاليًا مشاركة وكيل SmartDocs.
ملاحظة: تأكَّد من عدم وضع علامة في المربّع مشفَّر.
- أضِف مفتاحًا باسم is_whitelist_configured، تكون قيمته YES.
- أضِف مفتاحًا ثانيًا باسم allowed_hosts، حيث تكون القيم هي أسماء مضيفين أو عناوين IP مفصولة بمسافات
يتمّ استدعاؤها من SmartDocs. قيمة "allowed_hosts" تضمين أي مضيفين مدرجين في مواصفات OpenAPI
تمت إضافتها إلى Smart Docs. على سبيل المثال، إذا كانت لديك مواصفات OpenAPI تستدعي
mocktarget.apigee.net، ستحتاج إلى إضافةmocktarget.apigee.netإلى قيمة allowed_hosts. إذا لم يكن مضيف مُدرَجًا في KVM، سيكون ردّ SmartDocs هو400 Bad Requestمع حمولة محتوى تبلغBad Request-Hostname not permitted.
ملاحظة: في حالة عدم إضافة KVM وتهيئته، لن يفرض الخادم الوكيل الإضافة إلى القائمة البيضاء. وقد يؤدي ذلك
إلى الوصول غير المصرّح به إلى المضيفين وعناوين IP. يجب تضمين أسماء المضيفين وعناوين IP لنقاط نهاية واجهة برمجة التطبيقات الموثَّقة باستخدام SmartDocs فقط في قيم "allowed_hosts".