Descubra como integrar o Apidog ao Algolia para aprimorar a funcionalidade de pesquisa da sua documentação de API.
Por padrão, a documentação de API publicada inclui um recurso de pesquisa integrado que permite que os usuários pesquisem endpoints ou documentação por nome ou caminho.Além disso, o Apidog oferece integração com o Algolia para aprimorar os recursos de pesquisa. Para aproveitar esse recurso, você precisará habilitá-lo e concluir as configurações necessárias.É necessário usar o Apidog versão v2.6.31 ou posterior.
Etapa 1: Criar uma conta do Algolia#
2.
Após o registro, faça login na sua conta do Algolia.
Etapa 2: Criar uma aplicação do Algolia#
1.
Após fazer login, crie uma nova aplicação no painel do Algolia.
2.
Clique em Upload a File para fazer upload dos dados.
Para facilitar a configuração inicial, você pode usar o código de exemplo fornecido para gerar um arquivo JSON. Basta arrastar e soltar o arquivo JSON no Algolia. O nome do arquivo JSON será o seu Index Name, que você precisará posteriormente na configuração de pesquisa da documentação do Apidog.
3.
Projete a exibição da sua pesquisa.
4.
Prossiga clicando em Next até chegar à etapa final.
5.
Na etapa final, você será solicitado a informar como deseja criar o front-end de pesquisa. Você pode ignorar essa opção.
1.
Navegue até a página Settings -> API Keys do Algolia e obtenha os detalhes de configuração da sua aplicação.
Index Name será exibido aqui:2.
Copie e preencha esses detalhes de configuração nas configurações de pesquisa da documentação do Apidog.
Etapa 4: Salvar e habilitar o recurso#
Depois de preencher os detalhes de configuração necessários no Apidog, salve as configurações para habilitar a funcionalidade de pesquisa aprimorada.Se você atingir os limites do plano gratuito, verá uma notificação no Apidog: Ask AI#
O recurso Ask AI permite que os usuários tenham uma experiência de perguntas e respostas conversacional, baseada em IA, diretamente na pesquisa da sua documentação. Você pode habilitar o recurso Ask AI vinculando seu assistant_id nas configurações de Documentation Search, conforme mostrado abaixo.Nas fontes permitidas ou na lista de permissões do Algolia Ask AI, adicione a URL/domínio da sua documentação do Apidog, conforme mostrado na imagem abaixo.Plano gratuito Algolia DocSearch#
O Algolia oferece um plano DocSearch gratuito para finalidades específicas, como pesquisa em documentação. Você pode solicitar o plano gratuito Algolia DocSearch aqui. No campo Documentation URL do formulário de solicitação, você pode inserir a URL pública da sua documentação de API do Apidog.Quando a solicitação for aprovada, o Algolia enviará um e-mail de confirmação, e você receberá uma mensagem no painel do Algolia convidando você a ingressar na aplicação. Clique para confirmar a entrada na aplicação oferecida pelo Algolia.Após a confirmação, siga o mesmo processo mencionado acima para obter os detalhes de configuração da sua aplicação e vinculá-la ao seu projeto do Apidog.