Temukan cara mengintegrasikan Apidog dengan Algolia untuk meningkatkan fungsionalitas pencarian pada dokumentasi API Anda.
Secara default, dokumentasi API yang dipublikasikan mencakup fitur pencarian bawaan yang memungkinkan pengguna mencari endpoint atau dokumentasi berdasarkan nama atau path.Selain itu, Apidog menawarkan integrasi dengan Algolia untuk meningkatkan kemampuan pencarian. Untuk memanfaatkan fitur ini, Anda perlu mengaktifkannya dan menyelesaikan konfigurasi yang diperlukan.Diperlukan Apidog versi v2.6.31 atau yang lebih baru.
Mengintegrasikan Algolia dengan Apidog#
Langkah 1: Buat Akun Algolia#
2.
Setelah mendaftar, masuk ke akun Algolia Anda.
Langkah 2: Buat Aplikasi Algolia#
1.
Setelah masuk, buat aplikasi baru di dasbor Algolia.
2.
KlikUpload a Fileuntuk mengunggah data.
Agar lebih mudah memulai penyiapan, Anda dapat menggunakan contoh kode yang disediakan untuk menghasilkan file JSON. Cukup seret dan lepas file JSON tersebut ke Algolia. Nama file JSON tersebut akan menjadi Index Name, yang akan Anda perlukan nanti dalam konfigurasi pencarian dokumentasi Apidog.
3.
Rancang tampilan pencarian Anda.
4.
Lanjutkan dengan mengklikNexthingga Anda mencapai langkah terakhir.
5.
Pada langkah terakhir, Anda akan ditanya bagaimana Anda ingin membangun front-end pencarian. Anda dapat melewati opsi ini.
Langkah 3: Konfigurasikan Apidog dengan Pengaturan Algolia#
1.
Buka halaman Settings -> API Keys Algolia dan dapatkan detail konfigurasi untuk aplikasi Anda.
Index Nameakan ditampilkan di sini:2.
Salin dan isi detail konfigurasi ini ke pengaturan pencarian dokumentasi Apidog.
Langkah 4: Simpan dan Aktifkan Fitur#
Setelah mengisi detail konfigurasi yang diperlukan di Apidog, simpan pengaturan untuk mengaktifkan fungsionalitas pencarian yang ditingkatkan.Jika Anda mencapai batas paket gratis, Anda akan melihat notifikasi di Apidog: Ask AI#
Fitur Ask AI memungkinkan pengguna menikmati tanya jawab percakapan berbasis AI secara langsung di dalam pencarian dokumentasi Anda. Anda dapat mengaktifkan fitur Ask AI dengan mengikat assistant_id Anda di pengaturan Pencarian Dokumentasi seperti yang ditunjukkan di bawah ini.Dalam sumber yang diizinkan atau whitelist Algolia Ask AI, tambahkan URL/domain dokumentasi Apidog Anda, seperti yang ditunjukkan pada gambar di bawah ini.Paket Algolia DocSearch Gratis#
Algolia menawarkan paket DocSearch gratis untuk tujuan tertentu (seperti pencarian dokumentasi). Anda dapat mengajukan paket Algolia DocSearch gratis di sini. Untuk bidang Documentation URL pada formulir pengajuan, Anda dapat memasukkan URL dokumentasi API publik Anda dari Apidog.Setelah pengajuan berhasil, Algolia akan mengirimkan email konfirmasi kepada Anda, dan Anda akan menerima pesan di dasbor Algolia yang mengundang Anda untuk bergabung dengan aplikasi. Klik untuk mengonfirmasi agar bergabung dengan aplikasi yang ditawarkan Algolia.Setelah konfirmasi, ikuti proses yang sama seperti yang disebutkan di atas untuk mendapatkan detail konfigurasi aplikasi Anda dan mengikatnya dengan proyek Apidog Anda.