Recursos de IA

Torne sua documentação de API pronta para IA com recursos de IA que permitem integração fluida com assistentes de IA e ferramentas de desenvolvimento. Esses recursos ajudam desenvolvedores a aproveitar ferramentas de IA como Cursor, Cline e outras IDEs com IA para acelerar a integração de APIs e a geração de código.

Requisito de versão

A versão do Apidog deve ser ≥ 2.7.2 para acessar esses recursos.

Para habilitar esses recursos: Navegue até Publish Docs → Publish Docs Sites → AI Features.

Perguntar à IA

Este recurso habilita a funcionalidade de pesquisa conversacional na sua página de documentação. Você pode conectar seu Assistente de IA da Algolia para utilizar este recurso. Você pode saber mais sobre este recurso na seção Ask AI da página Pesquisa na documentação.

Habilitar MCP (Model Context Protocol)

Quando habilitado, um botão "MCP" aparece na sua documentação, orientando os usuários sobre como conectar sua documentação de API a IDEs compatíveis com MCP, como Cursor e Cline. Isso permite que a IA Agentic ajude na geração de código diretamente a partir da sua documentação de API.

Saiba mais

Para instruções detalhadas de configuração, leia: Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Habilitar Copiar Página

Quando habilitado, um botão "Copy page" aparece na sua documentação, permitindo que os usuários copiem a página atual em formato Markdown — perfeito para colar em conversas com IA.

Habilitar llms.txt

Quando habilitado, um arquivo Markdown llms.txt é gerado automaticamente no diretório raiz do seu site de documentação. Esse arquivo contém links para todas as páginas Markdown com descrições concisas, facilitando a descoberta e a navegação pela sua documentação por assistentes de IA.

Exemplo:

Como assistentes de IA usam llms.txt

Há dois métodos comuns para usar llms.txt e arquivos Markdown relacionados:

1. Compartilhe links Markdown com assistentes de IA que podem acessar URLs

Cada página de documentação online publicada via Apidog tem uma versão Markdown. Você pode:

Adicionar ".md" a qualquer URL de documentação (por exemplo, https://example.apidog.io/page.md)

Ou clicar em "View as Markdown" na documentação online

Assistentes de IA com recursos de Web Browsing podem usar essas URLs ".md" para recuperar documentação concisa.

Por exemplo, no Cursor, você pode pedir "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client".

Formato do prompt

O formato do prompt deve seguir as regras específicas da ferramenta de IA em uso. Por exemplo, no Cursor, as URLs devem começar com @ para serem reconhecidas como contexto.

2. Copie conteúdo Markdown para assistentes de IA que não conseguem acessar URLs

Se o assistente de IA não puder acessar conteúdo via URL, você precisará copiar e colar o conteúdo Markdown manualmente.

Clique no botão "Copy Page" na documentação online para obter o conteúdo da página atual em formato Markdown e, em seguida, cole-o na sua conversa com o assistente de IA.

Exemplo de prompt:

"Com base nesta definição de endpoint, gere um cliente TypeScript: (cole o conteúdo copiado aqui)."

Perguntas frequentes

Habilitar llms.txt afeta a segurança da documentação?

Não. llms.txt inclui apenas conteúdo que já foi publicado publicamente. Ele simplesmente converte HTML para Markdown e não expõe documentação privada ou não publicada. Se o controle de acesso (senha, lista de permissões de IP, lista de permissões de e-mail etc.) estiver configurado, os usuários ainda precisarão passar pela autenticação para acessar llms.txt e arquivos Markdown.

Posso usar llms.txt se minha documentação estiver protegida por senha, IP ou lista de permissões de e-mail?？

Por que não vejo o botão `Copy Page` no Apidog App?

Habilitei o recurso 'Web Search' para meu assistente de IA. Por que ele não consegue ler o conteúdo da página da web via URL?

O que devo fazer se o assistente de IA falhar ao acessar o arquivo Markdown via URL?

Preciso fazer mais alguma coisa depois de habilitar llms.txt?

Como posso verificar se llms.txt está funcionando corretamente?

Perguntar à IA#

Habilitar MCP (Model Context Protocol)#

Habilitar Copiar Página#

Habilitar llms.txt#

Como assistentes de IA usam llms.txt#

Perguntas frequentes#

Perguntar à IA

Habilitar MCP (Model Context Protocol)

Habilitar Copiar Página

Habilitar llms.txt

Como assistentes de IA usam llms.txt

Perguntas frequentes