Descubra cómo integrar Apidog con Algolia para mejorar la funcionalidad de búsqueda de su documentación de API.
De forma predeterminada, la documentación de API publicada incluye una función de búsqueda integrada que permite a los usuarios buscar endpoints o documentación por nombre o ruta.Además, Apidog ofrece integración con Algolia para mejorar las capacidades de búsqueda. Para aprovechar esta función, deberá habilitarla y completar las configuraciones requeridas.Se requiere la versión de Apidog v2.6.31 o posterior.
Integrar Algolia con Apidog#
Paso 1: Crear una cuenta de Algolia#
2.
Después de registrarse, inicie sesión en su cuenta de Algolia.
Paso 2: Crear una aplicación de Algolia#
1.
Una vez que haya iniciado sesión, cree una nueva aplicación en el panel de Algolia.
2.
Haga clic en Upload a File para cargar datos.
Para quienes empiezan, con el fin de configurar más fácilmente, puede utilizar el código de ejemplo proporcionado para generar un archivo JSON. Simplemente arrastre y suelte el archivo JSON en Algolia. El nombre del archivo JSON será su Index Name, que necesitará más adelante en la configuración de búsqueda de documentación de Apidog.
3.
Diseñe la visualización de su búsqueda.
4.
Continúe haciendo clic en Next hasta llegar al paso final.
5.
En el paso final, se le preguntará cómo desea crear el front-end de búsqueda. Puede omitir esta opción.
Paso 3: Configurar Apidog con los ajustes de Algolia#
1.
Navegue a la página Settings -> API Keys de Algolia y obtenga los detalles de configuración de su aplicación.
Index Name se mostrará aquí:2.
Copie y complete estos detalles de configuración en los ajustes de búsqueda de documentación de Apidog.
Paso 4: Guardar y habilitar la función#
Después de completar los detalles de configuración requeridos en Apidog, guarde los ajustes para habilitar la funcionalidad de búsqueda mejorada.Si alcanza los límites del plan gratuito, verá una notificación en Apidog: Ask AI#
La función Ask AI permite a los usuarios experimentar preguntas y respuestas conversacionales con tecnología de IA directamente dentro de la búsqueda de su documentación. Puede habilitar la función Ask AI vinculando su assistant_id en los ajustes de Documentation Search, como se muestra a continuación.En las fuentes permitidas o la lista blanca de Algolia Ask AI, agregue la URL o el dominio de su documentación de Apidog, como se muestra en la imagen siguiente.Plan gratuito Algolia DocSearch#
Algolia ofrece un plan DocSearch gratuito para fines específicos, como la búsqueda en documentación. Puede solicitar el plan gratuito Algolia DocSearch aquí. Para el campo Documentation URL del formulario de solicitud, puede introducir la URL pública de su documentación de API desde Apidog.Una vez que la solicitud se haya realizado correctamente, Algolia le enviará un correo electrónico de confirmación y recibirá un mensaje en el panel de Algolia invitándole a unirse a la aplicación. Haga clic para confirmar que desea unirse a la aplicación que ofrece Algolia.Después de la confirmación, siga el mismo proceso mencionado anteriormente para obtener los detalles de configuración de su aplicación y vincularla con su proyecto de Apidog.