Funciones de IA

Prepare su documentación de API para IA con funciones de IA que permiten una integración fluida con asistentes de IA y herramientas de desarrollo. Estas funciones ayudan a los desarrolladores a aprovechar herramientas de IA como Cursor, Cline y otros IDE con tecnología de IA para acelerar la integración de API y la generación de código.

Requisito de versión

La versión de Apidog debe ser ≥ 2.7.2 para acceder a estas funciones.

Para habilitar estas funciones: Vaya a Publish Docs → Publish Docs Sites → AI Features.

Ask AI

Esta función habilita la búsqueda conversacional en su página de documentación. Puede conectar su AI Assistant de Algolia para utilizar esta función. Puede obtener más información sobre esta función en la sección Ask AI de la página Documentation Search.

Habilitar MCP (Model Context Protocol)

Cuando está habilitado, aparece un botón "MCP" en su documentación, que guía a los usuarios sobre cómo conectar su documentación de API a IDE compatibles con MCP, como Cursor y Cline. Esto permite que la IA agéntica ayude con la generación de código directamente desde su documentación de API.

Más información

Para obtener instrucciones de configuración detalladas, lea: Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Habilitar Copy Page

Cuando está habilitado, aparece un botón "Copy page" en su documentación, lo que permite a los usuarios copiar la página actual en formato Markdown, ideal para pegarla en conversaciones con IA.

Habilitar llms.txt

Cuando está habilitado, se genera automáticamente un archivo Markdown llms.txt en el directorio raíz de su sitio de documentación. Este archivo contiene enlaces a cada página Markdown con descripciones concisas, lo que facilita que los asistentes de IA descubran y naveguen por su documentación.

Ejemplo:

Cómo utilizan llms.txt los asistentes de IA

Existen dos métodos comunes para usar llms.txt y los archivos Markdown relacionados:

1. Comparta enlaces Markdown con asistentes de IA que puedan acceder a URL

Cada página de documentación en línea publicada mediante Apidog tiene una versión Markdown. Usted puede:

Añadir ".md" a cualquier URL de documentación (por ejemplo, https://example.apidog.io/page.md)

O hacer clic en "View as Markdown" en la documentación en línea

Los asistentes de IA con capacidades de Web Browsing pueden usar estas URL ".md" para recuperar documentación concisa.

Por ejemplo, en Cursor, puede solicitar "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client".

Formato de prompt

El formato del prompt debe seguir las reglas específicas de la herramienta de IA que se esté utilizando. Por ejemplo, en Cursor, las URL deben comenzar con @ para que se reconozcan como contexto.

2. Copie contenido Markdown para asistentes de IA que no puedan acceder a URL

Si el asistente de IA no puede acceder al contenido mediante URL, debe copiar y pegar el contenido Markdown manualmente.

Haga clic en el botón "Copy Page" en la documentación en línea para obtener el contenido de la página actual en formato Markdown y, a continuación, péguelo en su conversación con el asistente de IA.

Prompt de ejemplo:

"Con base en esta definición de endpoint, genere un cliente TypeScript: (pegue aquí el contenido copiado)."

Preguntas frecuentes

¿Habilitar llms.txt afecta la seguridad de la documentación?

No. llms.txt solo incluye contenido que ya se ha publicado públicamente. Simplemente convierte HTML a Markdown y no expone documentación privada ni no publicada. Si se ha configurado el control de acceso (contraseña, lista de IP permitidas, lista de correos electrónicos permitidos, etc.), los usuarios aún deben superar la autenticación para acceder a llms.txt y a los archivos Markdown.

¿Puedo usar llms.txt si mi documentación está protegida por contraseña, IP o lista de correos electrónicos permitidos?？

¿Por qué no veo el botón `Copy Page` en la aplicación Apidog?

He habilitado la función 'Web Search' para mi asistente de IA. ¿Por qué no puede leer el contenido de la página web mediante URL?

¿Qué debo hacer si el asistente de IA no logra acceder al archivo Markdown mediante URL?

¿Necesito hacer algo más después de habilitar llms.txt?

¿Cómo puedo verificar que llms.txt funciona correctamente?

Ask AI#

Habilitar MCP (Model Context Protocol)#

Habilitar Copy Page#

Habilitar llms.txt#

Cómo utilizan llms.txt los asistentes de IA#

Preguntas frecuentes#

Ask AI

Habilitar MCP (Model Context Protocol)

Habilitar Copy Page

Habilitar llms.txt

Cómo utilizan llms.txt los asistentes de IA

Preguntas frecuentes