Cài đặt SmartDocs

SmartDocs được cài đặt tự động khi bạn cài đặt và chạy tập lệnh kiểm tra cài đặt được mô tả trong Kiểm thử cài đặt. Trong quá trình chạy kiểm thử tập lệnh, bạn hãy chạy các lệnh sau:

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

Trong đó configFile là tệp cấu hình mà bạn đã dùng để cài đặt Edge. Hãy xem phần Cài đặt các thành phần Edge trên một nút để biết thêm thông tin.

Lệnh này cài đặt SmartDocs trong quá trình chạy kiểm thử.

Cách hoàn tất quá trình cài đặt:

  1. Kiểm tra xem SmartDocs đã được cài đặt chưa bằng cách xác nhận rằng tệp smartdocs.zip nằm trong thư mục sau:

    /opt/apigee/apigee-validate/bundles/

    Hoặc chạy lệnh gọi API sau trên nút Máy chủ quản lý:

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

    Lệnh này sẽ trả về kết quả sau nếu bạn đã cài đặt SmartDocs:

    [ "smartdocs", "passthrough" ]
  2. Trong giao diện người dùng Edge, hãy tạo và cập nhật một KVM có tên là “smartdocs_listings” (tên hiển thị trong hình bên dưới). Bạn nên tạo KVM trong tổ chức và môi trường mà proxy SmartDocs hiện đang được triển khai.

    Lưu ý: Đảm bảo rằng bạn KHÔNG chọn hộp được mã hoá.

    • Thêm khoá có tên là "is_inventory_configure", trong đó giá trị là "YES".
    • Thêm khoá thứ hai có tên là "máy_chủ_được_cho_phép", trong đó các giá trị là tên máy chủ hoặc địa chỉ IP được phân tách bằng dấu cách được gọi từ SmartDocs. Giá trị của "allowed_hosts" phải bao gồm mọi máy chủ có trong thông số kỹ thuật OpenAPI được thêm vào SmartDocs. Ví dụ: nếu bạn có thông số kỹ thuật OpenAPI gọi mocktarget.apigee.net, bạn sẽ cần thêm mocktarget.apigee.net vào " allowed_hosts" giá trị. Nếu máy chủ không phải là có trong KVM, phản hồi của SmartDocs sẽ là 400 Bad Request kèm theo nội dung tải trọng Bad Request-Hostname not permitted.
    Giao diện tạo KVM Lưu ý: Nếu bạn không thêm và định cấu hình KVM này, thì proxy sẽ không thực thi việc đưa vào danh sách trắng. Điều này có thể dẫn đến việc truy cập trái phép vào máy chủ và địa chỉ IP của bạn. Chỉ những tên máy chủ và địa chỉ IP của điểm cuối API được ghi lại bằng SmartDocs mới được đưa vào giá trị "allowed_hosts".