Khám phá cách tích hợp Apidog với Algolia để nâng cao chức năng tìm kiếm cho tài liệu API của bạn.
Theo mặc định, tài liệu API đã xuất bản bao gồm một tính năng tìm kiếm tích hợp cho phép người dùng tìm kiếm endpoint hoặc tài liệu theo tên hoặc đường dẫn.Ngoài ra, Apidog cung cấp khả năng tích hợp với Algolia để nâng cao năng lực tìm kiếm. Để tận dụng tính năng này, bạn cần bật tính năng và hoàn tất các cấu hình bắt buộc.Yêu cầu Apidog phiên bản v2.6.31 trở lên.
Tích hợp Algolia với Apidog#
Bước 1: Tạo tài khoản Algolia#
2.
Sau khi đăng ký, đăng nhập vào tài khoản Algolia của bạn.
Bước 2: Tạo ứng dụng Algolia#
1.
Sau khi đăng nhập, tạo một ứng dụng mới trong bảng điều khiển Algolia.
2.
Nhấp vàoUpload a Fileđể tải dữ liệu lên.
Để người mới bắt đầu thiết lập dễ dàng hơn, bạn có thể sử dụng đoạn mã ví dụ được cung cấp để tạo tệp JSON. Chỉ cần kéo và thả tệp JSON vào Algolia. Tên của tệp JSON sẽ là Index Name của bạn, thông tin này bạn sẽ cần sau trong cấu hình tìm kiếm tài liệu của Apidog.
3.
Thiết kế cách hiển thị tìm kiếm của bạn.
4.
Tiếp tục bằng cách nhấp vàoNextcho đến khi bạn đến bước cuối cùng.
5.
Ở bước cuối cùng, bạn sẽ được hỏi muốn xây dựng giao diện tìm kiếm front-end như thế nào. Bạn có thể bỏ qua tùy chọn này.
Bước 3: Cấu hình Apidog bằng cài đặt Algolia#
1.
Điều hướng đến trang Algolia Settings -> API Keys và lấy thông tin cấu hình cho ứng dụng của bạn.
Index Namesẽ được hiển thị tại đây:2.
Sao chép và điền các thông tin cấu hình này vào phần cài đặt tìm kiếm tài liệu của Apidog.
Bước 4: Lưu và bật tính năng#
Sau khi điền các thông tin cấu hình bắt buộc trong Apidog, hãy lưu cài đặt để bật chức năng tìm kiếm nâng cao.Nếu bạn chạm giới hạn của gói miễn phí, bạn sẽ thấy thông báo trong Apidog: Ask AI#
Tính năng Ask AI cho phép người dùng trải nghiệm hỏi đáp dạng hội thoại, được hỗ trợ bởi AI, trực tiếp trong phần tìm kiếm tài liệu của bạn. Bạn có thể bật tính năng Ask AI bằng cách liên kết assistant_id của mình trong cài đặt Documentation Search như minh họa bên dưới.Trong các nguồn được phép hoặc whitelist của Algolia Ask AI, hãy thêm URL/tên miền tài liệu Apidog của bạn, như minh họa trong hình bên dưới.Gói Algolia DocSearch miễn phí#
Algolia cung cấp gói DocSearch miễn phí cho các mục đích cụ thể (chẳng hạn như tìm kiếm tài liệu). Bạn có thể đăng ký gói Algolia DocSearch miễn phí tại đây. Đối với trường Documentation URL trong biểu mẫu đăng ký, bạn có thể nhập URL tài liệu API công khai của mình từ Apidog.Sau khi đăng ký thành công, Algolia sẽ gửi cho bạn email xác nhận, và bạn sẽ nhận được thông báo trong bảng điều khiển Algolia mời bạn tham gia ứng dụng. Nhấp để xác nhận tham gia ứng dụng mà Algolia cung cấp.Sau khi xác nhận, hãy thực hiện theo cùng quy trình đã đề cập ở trên để lấy thông tin cấu hình cho ứng dụng của bạn và liên kết ứng dụng đó với dự án Apidog của bạn.