Cài đặt SmartDocs

SmartDocs được cài đặt tự động khi bạn cài đặt và chạy các tập lệnh kiểm thử cài đặt được mô tả trong phần Kiểm thử quá trình cài đặt. Trong quá trình chạy tập lệnh kiểm thử, bạn 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à cùng một tệp cấu hình mà bạn đã dùng để cài đặt Edge. 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 hay 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 SmartDocs được cài đặt:

    [ "smartdocs", "passthrough" ]
  2. Trên 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_whitelist" như 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 đánh dấu vào hộp đã mã hoá.

    • Thêm một khoá có tên là "is_whitelist_configured" với giá trị là "YES".
    • Thêm khoá thứ hai có tên là "allowed_hosts", 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ủ lưu trữ có trong thông số kỹ thuật OpenAPI được thêm vào SmartDocs. Ví dụ: nếu có một thông số kỹ thuật OpenAPI gọi mocktarget.apigee.net, bạn sẽ cần thêm mocktarget.apigee.net vào giá trị "allowed_hosts". Nếu một máy chủ lưu trữ không có trong KVM, thì phản hồi của SmartDocs sẽ là 400 Bad Request với tải trọng nội dung là 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 danh sách cho phép. Đ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 các điểm cuối API được ghi lại bằng SmartDocs mới được đưa vào giá trị "allowed_hosts".