Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Publish API Docs
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Generate Schemas from JSON etc.
      • Build a schema
      • Overview
      • Create a new schema
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Postman scripts reference
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Jenkins
      • Integration with Gitlab
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Folder tree settings
    • Custom layouts
    • Visibility settings
    • Endpoint SEO settings
    • Custom domain
    • Embedding values in document URLs
    • Documentation Search
    • Integrating Google Analytics with Doc Sites
    • CORS Proxy
    • API Versions
      • Overview
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • Apidog MCP Server
    • Overview
    • Conntect API Specification within Apidog Project to AI via Apidog MCP Server
    • Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Conntect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Language settings
    • Data backup
    • Network proxy configuration
    • Hot keys
    • Updating Apidog
    • Generate OpenAPI access token
    • Deleting account
    • Account settings
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. Publish API Docs

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.
search-bar-api-documentation.png
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.
algolia-search-integration.png
integrating-algolia-search-apidog.png
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.
algoria-website.png

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.
uploading-files-algolia.png
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.
upload-records-algolia.png
3.
Design your search display.
designing-search-display-algolia.png
4.
Proceed by clickingNextuntil you reach the final step.
order-results-setting-algolia.png
5.
In the final step, you will be asked how you want to build the search front-end. You can skip this option.
finish-algolia-settings.png

Step 3: Configure Apidog with Algolia Settings#

1.
In the Algolia dashboard, locate the configuration details for your application.
finding-algolia-api-keys.png
TheIndex Namewill be displayed here:
finding-algolia-index-name.png
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.
integrating-algolia-with-apidog.png
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:
algolia-limits.png

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.
applying-algolia-free-plan.png
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.
image.png
To find theWrite API Key, follow the steps below:
get-algolia-api-key-step-1.png
get-algolia-api-key-step-2.png
The Algolia API Key here needs to be configured into the Write API Key in the Apidog configuration item.
get-algolia-api-key-step-3.png
Similarly, the value ofIndex Namecan be found here:
finding-algolia-free-plan-index-name.png
Modified at 2024-12-04 10:40:42
Previous
Embedding values in document URLs
Next
Integrating Google Analytics with Doc Sites
Built with