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/
یا فراخوانی میانای برنامه‌سازی کاربردی زیر را در گره «سرور مدیریت» اجرا کنید:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
اگر SmartDocs نصب شده باشد، این فرمان باید موارد زیر را برگرداند:
[ "smartdocs", "passthrough" ]
- از Edge UI، یک 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» گنجانده شوند.