هنگام نصب و اجرای اسکریپت های تست نصب شرح داده شده در Test the install، 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/
یا فراخوانی API زیر را روی گره مدیریت سرور اجرا کنید:
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 گنجانده نشده باشد، پاسخ SmartDocs400 Bad Requestخواهد بود و محتوای محتویBad Request-Hostname not permitted.
توجه : اگر این KVM را اضافه و پیکربندی نکنید، پروکسی لیست سفید را اعمال نخواهد کرد. این می تواند منجر به دسترسی غیرمجاز به هاست و آدرس های IP شما شود. فقط نام میزبان و آدرس IP نقاط پایانی API مستند شده با SmartDocs باید در مقادیر "allowed_hosts" گنجانده شود.