Funcionalidades de IA

Torne a sua documentação de API pronta para IA com funcionalidades de IA que permitem uma integração fluida com assistentes de IA e ferramentas de desenvolvimento. Estas funcionalidades ajudam os programadores a tirar partido de ferramentas de IA como Cursor, Cline e outros 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 aceder a estas funcionalidades.

Para ativar estas funcionalidades: Navegue para Publish Docs → Publish Docs Sites → AI Features.

Ask AI

Esta funcionalidade permite a pesquisa conversacional na sua página de documentação. Pode ligar o seu Assistente de IA da Algolia para utilizar esta funcionalidade. Pode saber mais sobre esta funcionalidade na secção Ask AI da página Documentation Search.

Ativar MCP (Model Context Protocol)

Quando ativado, aparece um botão "MCP" na sua documentação, orientando os utilizadores sobre como ligar a sua documentação de API a IDEs compatíveis com MCP, como Cursor e Cline. Isto permite que a IA agêntica ajude na geração de código diretamente a partir da sua documentação de API.

Saber Mais

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

Ativar Copiar Página

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

Ativar llms.txt

Quando ativado, é gerado automaticamente um ficheiro Markdown llms.txt no diretório raiz do seu site de documentação. Este ficheiro contém ligações para todas as páginas Markdown com descrições concisas, facilitando aos assistentes de IA a descoberta e navegação na sua documentação.

Exemplo:

Como os Assistentes de IA Utilizam o llms.txt

Existem dois métodos comuns para utilizar o llms.txt e ficheiros Markdown relacionados:

1. Partilhar ligações Markdown com assistentes de IA que conseguem aceder a URLs

Cada página de documentação online publicada através do Apidog tem uma versão Markdown. Pode:

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

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

Os assistentes de IA com capacidades de Navegação Web podem utilizar estes URLs ".md" para obter documentação concisa.

Por exemplo, no Cursor, 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 utilizada. Por exemplo, no Cursor, os URLs devem começar com @ para serem reconhecidos como contexto.

2. Copiar conteúdo Markdown para assistentes de IA que não conseguem aceder a URLs

Se o assistente de IA não conseguir aceder ao conteúdo através de URL, tem de copiar e colar manualmente o conteúdo Markdown.

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:

"Based on this endpoint definition, please generate a TypeScript client: (paste the copied content here)."

Perguntas Frequentes

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

Não. O llms.txt inclui apenas conteúdo que já foi publicado publicamente. Simplesmente converte HTML em Markdown e não expõe documentação privada ou não publicada. Se o controlo de acesso (palavra-passe, lista de permissões de IP, lista de permissões de email, etc.) estiver configurado, os utilizadores continuam a ter de passar pela autenticação para aceder ao llms.txt e aos ficheiros Markdown.

Posso utilizar o llms.txt se a minha documentação estiver protegida por palavra-passe, IP ou lista de permissões de email?？

Porque não vejo o botão `Copy Page` na aplicação Apidog?

Ativei a funcionalidade 'Web Search' para o meu assistente de IA. Porque é que ele não consegue ler o conteúdo da página web através de URL?

O que devo fazer se o assistente de IA não conseguir aceder ao ficheiro Markdown através de URL?

Preciso de fazer mais alguma coisa depois de ativar o llms.txt?

Como posso verificar se o llms.txt está a funcionar corretamente?

Funcionalidades de IA

Ask AI#

Ativar MCP (Model Context Protocol)#

Ativar Copiar Página#

Ativar llms.txt#

Como os Assistentes de IA Utilizam o llms.txt#

Perguntas Frequentes#

Ask AI

Ativar MCP (Model Context Protocol)

Ativar Copiar Página

Ativar llms.txt

Como os Assistentes de IA Utilizam o llms.txt

Perguntas Frequentes