نصب SmartDocs

وقتی دستورگان آزمایش نصب را که در آزمایش نصب توضیح داده شده است نصب و اجرا می‌کنید، 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 را به‌عنوان بخشی از اجرای آزمایش‌ها نصب می‌کند.

برای تکمیل نصب:

  1. با تأیید اینکه فایل smartdocs.zip در دایرکتوری زیر قرار دارد، نصب SmartDocs را آزمایش کنید:

    /opt/apigee/apigee-validate/bundles/

    یا تماس با میانای برنامه‌سازی کاربردی زیر را در گره «سرور مدیریت» اجرا کنید:

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    اگر SmartDocs نصب شده باشد، این فرمان باید موارد زیر را برگرداند:

    [ "smartdocs", "passthrough" ]
  2. از «میانای کاربر 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 را به مقدار «میزبان‌های مجاز» اضافه کنید. اگر میزبان در KVM گنجانده نشده باشد، پاسخ SmartDocs 400 Bad Request با بار محتوای Bad Request-Hostname not permitted خواهد بود.
    میانای ساخت KVM توجه: اگر این KVM را اضافه و پیکربندی نکنید، کارگزار وکالتی فهرست سفید را اعمال نخواهد کرد. این کار می‌تواند منجر به دسترسی غیرمجاز به میزبان‌ها و نشانی‌های IP شما شود. فقط نام‌های میزبان و نشانی‌های IP نقطه‌های پایانی API مستندشده با SmartDocs باید در مقادیر «allowed_hosts» گنجانده شود.