Cài đặt SmartDocs

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

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

Để hoàn tất cài đặt:

  1. Kiểm tra để đảm bảo bạn đã cài đặt SmartDocs 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 đây trên nút Server Server:

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

    Lệnh này sẽ trả về thông báo sau đây nếu cài đặt SmartDocs:

    [ "smartdocs", "passthrough" ]
  2. Từ 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. KVM phải được tạo trong tổ chức và môi trường triển khai proxy SmartDocs.

    Lưu ý: Đảm bảo rằng bạn không chọn hộp được mã hóa.

    • Thêm khóa có tên “is_whitelist_ configured”, trong đó giá trị là “YES”.
    • Thêm khóa thứ hai có tên “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ủ có trong quy cách OpenAPI được thêm vào SmartDocs. Ví dụ: nếu có một thông số 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ủ không có trong KVM, phản hồi của SmartDocs sẽ là 400 Bad Request với 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, 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. Bạn chỉ nên đưa 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 vào giá trị "allowed_hosts".