Esta guía explica cómo cualquier persona — desarrolladores, producto, soporte o integraciones — puede utilizar la documentación de la API, con foco en:

Cómo utilizar el recurso Testar directamente en la documentación

Integrar la documentación con IDEs asistidas por IA mediante MCP Server (Model Context Protocol)

1. ✨ Usando el "Testar" en la documentación de la API

La documentación incluye un recurso interactivo llamado "Testar", que permite probar los endpoints directamente desde la documentación, sin necesidad de abrir Postman, Insomnia o la terminal.

1.1. Cómo usarlo

Abre la página de un endpoint

Haz clic en el botón Testar

Completa los campos según corresponda:

Query Params

Body

Headers

Auth

Haz clic en Enviar y podrás ver:

Request enviada

Response body

Headers

Status code

1.2. Consejos importantes

Asegúrate de configurar la autenticación previamente (Username: DNS, Password: Token).

Utiliza valores válidos para evitar errores.

Es ideal para validar el comportamiento real de los endpoints.

2. ⚙️ Integración con IA mediante el MCP Server de la documentación

Permite que IDEs como Cursor accedan automáticamente a la documentación de la API.

La documentación ofrece un servidor MCP (Model Context Protocol) que permite que herramientas como Cursor y VS Code + extensiones MCP accedan directamente a:

La especificación de la API

La documentación publicada

Esquemas

Endpoints

Componentes

Autenticación

Ejemplos

Es decir: la IA dentro de la IDE puede leer y utilizar toda tu API para generar código automáticamente.

2.1. ¿Qué permite hacer el MCP Server?

Con el MCP de Apidog, puedes:

Generar código listo basado en cualquier endpoint

Actualizar DTOs automáticamente

Crear servicios, controllers, rutas y llamadas a la API

Insertar comentarios basados en la documentación

Buscar endpoints por descripción

Validar requests

Crear tests basados en el schema

Y mucho más — todo sin copiar y pegar documentación manualmente.

La IA pasa a tener memoria local de tu API.

2.2. ¿Cómo funciona?

El MCP Server:

Descarga y guarda en caché localmente toda la documentación de la API

La IA de tu IDE accede a esos datos de forma nativa

Solo necesitas pedir algo como:

“Genera el servicio para el endpoint /appointments/schedule/detail usando el schema de la API.”

Y Cursor / VS Code generará TODO automáticamente.

2.3. Configuración con 1 clic

Puedes configurar el MCP utilizando el JSON a continuación.

Este ejemplo utiliza el ID del sitio 759651:

{
  "mcpServers": {
    "EVO API": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=759651"
      ]
    }
  }
}

📌 Requisitos

Node.js >= 18

IDE con soporte para MCP:

Cursor

VS Code (mediante plugins como Cline o AI MCP)

2.4. Configuración manual (si deseas personalizar)

Puedes ajustar:

Puertos

Caché

Access tokens (para documentación privada)

Fuente de datos (OpenAPI / Swagger / documentación online .txt)

Ejemplo

O, si es un entorno On-Premise:

2.5. ¿Qué hacer después de pegar el JSON?

En Cursor o VS Code:

Abre Settings → MCP Servers

Pega el JSON anterior

Reinicia la IDE

La IA comenzará a responder basándose en la documentación real.

Ejemplo de prompt útil:

“Usa el MCP para buscar el schema de Sales y generar una clase TypeScript con tipado completo.”

2.6. Documentación oficial del MCP Server

Apidog, proveedor del hosting de la documentación de la EVO API, mantiene documentación completa sobre:

Cómo funciona el MCP

Cómo conectar proyectos

Cómo usar documentación publicada como fuente

Cómo conectar Swagger / OpenAPI

Ler referencia completa

Utilizar la documentación de forma eficaz

1. ✨ Usando el "Testar" en la documentación de la API#

1.1. Cómo usarlo#

1.2. Consejos importantes#

2. ⚙️ Integración con IA mediante el MCP Server de la documentación#

2.1. ¿Qué permite hacer el MCP Server?#

2.2. ¿Cómo funciona?#

2.3. Configuración con 1 clic#

📌 Requisitos#

2.4. Configuración manual (si deseas personalizar)#

Ejemplo#

2.5. ¿Qué hacer después de pegar el JSON?#

2.6. Documentación oficial del MCP Server#