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 chính là tệp cấu hình mà bạn đã dùng để cài đặt Edge. Xem bài viết Cài đặt các thành phần của Edge trên một nút để biết thêm thông tin.

Lệnh này sẽ cài đặt SmartDocs như một phần của 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ề nội dung 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_ALIAS” như minh hoạ trong hình bên dưới. Bạn phải tạo KVM trong tổ chức và môi trường nơi proxy SmartDocs hiện đã đượ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" và giá trị là "YES".
    • Thêm khoá thứ hai có tên “ allowed_hosts”, trong đó 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ó tên qua SmartDocs. Giá trị của " allowed_hosts" phải bao gồm bất kỳ máy chủ nào 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 danh sách cho phép. Chiến dịch 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ỉ tên máy chủ và địa chỉ IP của Bạn phải đưa các điểm cuối API được ghi nhận bằng SmartDocs vào phần " allowed_hosts" giá trị.