Descubra como integrar o Apidog com o Algolia para melhorar a funcionalidade de pesquisa da sua documentação de API.
Por predefinição, a documentação de API publicada inclui uma funcionalidade de pesquisa integrada que permite aos utilizadores procurar endpoints ou documentação por nome ou caminho.Além disso, o Apidog oferece integração com o Algolia para melhorar as capacidades de pesquisa. Para tirar partido desta funcionalidade, terá de a ativar e concluir as configurações necessárias.É necessária a versão v2.6.31 ou posterior do Apidog.
Passo 1: Criar uma conta Algolia#
2.
Após o registo, inicie sessão na sua conta Algolia.
Passo 2: Criar uma aplicação Algolia#
1.
Depois de iniciar sessão, crie uma nova aplicação no painel do Algolia.
2.
Clique em Upload a File para carregar dados.
Para uma configuração inicial mais fácil, pode utilizar o código de exemplo fornecido para gerar um ficheiro JSON. Basta arrastar e largar o ficheiro JSON no Algolia. O nome do ficheiro JSON será o seu Index Name, de que precisará posteriormente na configuração de pesquisa da documentação do Apidog.
3.
Conceba a apresentação da sua pesquisa.
4.
Prossiga clicando em Next até chegar ao passo final.
5.
No passo final, ser-lhe-á perguntado como pretende criar o front-end de pesquisa. Pode ignorar esta opção.
1.
Navegue para a página Settings -> API Keys do Algolia e obtenha os detalhes de configuração da sua aplicação.
Index Name será apresentado aqui:2.
Copie e preencha estes detalhes de configuração nas definições de pesquisa da documentação do Apidog.
Passo 4: Guardar e ativar a funcionalidade#
Depois de preencher os detalhes de configuração necessários no Apidog, guarde as definições para ativar a funcionalidade de pesquisa melhorada.Se atingir os limites do plano gratuito, verá uma notificação no Apidog: Ask AI#
A funcionalidade Ask AI permite aos utilizadores desfrutar de perguntas e respostas conversacionais, com tecnologia de IA, diretamente na pesquisa da sua documentação. Pode ativar a funcionalidade Ask AI associando o seu assistant_id nas definições de Documentation Search, conforme mostrado abaixo.Nas fontes permitidas ou whitelist do Algolia Ask AI, adicione o 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 fins específicos (como pesquisa na documentação). Pode candidatar-se ao plano gratuito Algolia DocSearch aqui. Para o campo Documentation URL no formulário de candidatura, pode introduzir o URL público da sua documentação de API do Apidog.Assim que a candidatura for bem-sucedida, o Algolia enviar-lhe-á um e-mail de confirmação e receberá uma mensagem no painel do Algolia a convidá-lo a aderir à aplicação. Clique para confirmar a adesão à 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 associá-la ao seu projeto Apidog.