Documentation Search

Discover how to integrate Apidog with Algolia to enhance search functionality for your API documentation.

By default, the published API documentation includes a built-in search feature that lets users search for endpoints or documentation by name or path.

Additionally, Apidog offers integration with Algolia to enhance search capabilities. To take advantage of this feature, you'll need to enable it and complete the required configurations. Note that your Apidog version must be 2.6.31 or higher.

:::tip
Algolia is free to use, but it comes with certain limits. To increase these limits, you can either upgrade to Algolia's paid version or apply for the free Algolia DocSearch plan.
:::

Integrating Algolia with Apidog

Integrating Apidog with Algolia enhances the search functionality of your API documentation. Follow these steps to set it up:

Step 1: Create an Algolia Account

1. Visit the Algolia website and sign up for an account.
2. After registering, log in to your Algolia account.

Step 2: Create an Algolia Application

1. Once logged in, create a new application in the Algolia dashboard.
2. Click onUpload a Fileto upload data.

:::tip
For starters to set up easier, you can use the provided example code to generate a JSON file. Simply drag and drop the JSON file into Algolia. The JSON file's name will be your Index Name, which you’ll need later in Apidog’s documentation search configuration.
:::

3. Design your search display.

4. Proceed by clickingNextuntil you reach the final step.

5. In the final step, you will be asked how you want to build the search front-end. You can skip this option.

Step 3: Configure Apidog with Algolia Settings

1. In the Algolia dashboard, locate the configuration details for your application.

TheIndex Namewill be displayed here:

2. Copy and fill these configuration details into Apidog’s documentation search settings.

Step 4: Save and Enable the Feature

After filling in the required configuration details in Apidog, save the settings to enable the enhanced search functionality.

:::tip
While Algolia is free to use, there are limits on its usage. You can either upgrade to a paid plan for higher limits or apply for the free Algolia DocSearch plan.

If you hit the free plan’s limits, you will see a notification in Apidog:

:::

Free Algolia DocSearch Plan

Algolia offers a free DocSearch plan for specific purposes (like documentation search). You can apply for the free Algolia DocSearch plan here. For theDocumentation URLfield in the application form, you can enter your public API documentation URL from Apidog.

Once the application is successful, Algolia will send you an confirmation email, and you will receive a message in Algolia dashboard inviting you to join the application. Click to confirm to join the application Algolia offers.

After confirmation, switch to the application at the top left corner of the dashboard, copy theApplication IDandSearch API Keyand fill in the corresponding fields in Apidog. Please note that theWrite API Keyneeds to be found in a different location.

To find theWrite API Key, follow the steps below:

The Algolia API Key here needs to be configured into the Write API Key in the Apidog configuration item.

Similarly, the value ofIndex Namecan be found here: