يتم تثبيت 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، أنشئ KVM وعدِّله باسم smartdocs_whitelist، كما هو موضّح في الشكل أدناه.
يجب إنشاء KVM في المؤسسة والبيئة التي يتم فيها نشر خادم SmartDocs الوكيل حاليًا.
ملاحظة: تأكَّد من عدم وضع علامة في المربّع مشفَّر.
- أضِف مفتاحًا باسم "is_whitelist_configured"، حيث تكون القيمة "YES".
- أضِف مفتاحًا ثانيًا باسم "allowed_hosts"، حيث تكون القيم هي أسماء مضيفين أو عناوين IP مفصولة بمسافات
يتم استدعاؤها من SmartDocs. يجب أن تتضمّن قيمة "allowed_hosts" أي مضيفين مضمّنين في مواصفات OpenAPI
المضافة إلى SmartDocs. على سبيل المثال، إذا كانت لديك مواصفات 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".