Apifox MCP Server

Apifox MCP Server

Con Apifox MCP Server, puedes proporcionar la documentación de la API dentro de un proyecto de Apifox como fuente de datos a herramientas IDE que soportan programación con IA, como Cursor, para que la IA pueda acceder directamente a los datos de la documentación de la API del proyecto.

Los desarrolladores pueden usar el asistente de IA para: generar o modificar código según la documentación de la API, buscar contenido en la documentación, etc. En cuanto a qué más poderoso puede hacer la IA con estos datos de documentación, ¡usa tu imaginación y la de tu equipo 😜

🎯 Cómo usar

Después de instalar y configurar MCP, Apifox MCP Server leerá automáticamente los datos de toda la documentación de la API en el proyecto de Apifox y los almacenará en caché localmente. La IA puede leer los datos de la documentación de todos los endpoints del proyecto a través de MCP.

Solo tienes que decirle a la IA qué quieres hacer con la documentación de la API, por ejemplo:

1. "Obtén la documentación de la API a través de MCP y luego genera el código de definición de Product y sus modelos relacionados"
2. "Según la documentación de la API, agrega los nuevos campos que se han añadido en la documentación al DTO de Product"
3. "Según la documentación de la API, agrega comentarios a cada campo de la clase Product"
4. "Según la documentación de la API, genera todo el código MVC relacionado con el endpoint /users"

Nota: los datos de la documentación de la API se almacenan en caché localmente por defecto. Si los datos en Apifox se actualizan, dile a la IA que actualice los datos de la documentación; de lo contrario, la IA podría no leer los datos más recientes.

🚀 Método de instalación

Requisitos previos

• Tener instalado Node.js (versión >= 18, se recomienda la última versión LTS)
• Cualquier IDE que soporte MCP:
  • Cursor
  • VSCode + extensión Cline

Instalación

1. Generar un Access Token en Apifox a. Abre Apifox, pasa el cursor sobre el avatar en la esquina superior derecha y haz clic en "Configuración de cuenta -> Token de acceso a la API" b. Crea un nuevo token de acceso a la API, consulta la documentación de ayuda para más detalles c. Obtén el token de acceso a la API y reemplaza <access-token> en el archivo de configuración a continuación
2. Obtener el ID del proyecto de Apifox a. Abre el proyecto correspondiente en Apifox b. Haz clic en "Configuración del proyecto" en la barra lateral izquierda y copia el ID del proyecto en la página "Configuración básica" c. Obtén el ID del proyecto y reemplaza <project-id> en el archivo de configuración a continuación
3. Configurar el IDE

Agrega la siguiente configuración JSON al archivo de configuración MCP correspondiente del IDE:

{
  "mcpServers": {
    "API 文档": {
      "command": "npx",
      "args": [
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Si usas Windows y el archivo de configuración anterior no funciona correctamente, usa el siguiente archivo de configuración:

{
  "mcpServers": {
    "API 文档": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apifox-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIFOX_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

• Cursor: agrégalo al ~/.cursor/mcp.json global o al .cursor/mcp.json dentro del proyecto
• Cline: abre el panel de Cline > MCP Server > Configure MCP Server

Nota:

1. Reemplaza <access-token> y <project-id> con tu token de acceso a la API de Apifox personal y el ID del proyecto de Apifox.
2. Se recomienda que el nombre del MCP Server en el archivo de configuración sea algo como "API 文档" o "xxx API 文档" que contenga la palabra "API文档", para que la IA pueda identificar correctamente el propósito de este MCP Server. No se recomienda usar "Apifox" o "Apifox MCP", ya que la IA no puede identificar fácilmente su propósito.
3. Si necesitas usar la documentación de la API de varios proyectos, simplemente agrega múltiples MCP Servers en el archivo de configuración (cada proyecto tiene un <project-id> diferente), y nombra el MCP Server como "xxx API 文档".
4. Si tu equipo suele sincronizar el archivo de configuración de MCP en el repositorio de código, se recomienda eliminar "APIFOX_ACCESS_TOKEN": "<access-token>" de la configuración y, en su lugar, que cada miembro configure una variable de entorno llamada APIFOX_ACCESS_TOKEN en su propia computadora para evitar la fuga de APIFOX_ACCESS_TOKEN.
5. Los usuarios de la versión de implementación privada deben agregar el parámetro "--apifox-api-base-url=<私有化部署服务器的 API 地址，以 http:// 或 https:// 开头>" en el archivo de configuración MCP del IDE. Además, asegúrate de que la red pueda acceder correctamente a www.npm.com.
6. Además de los proyectos de Apifox, también se admite la lectura directa de archivos Swagger/OAS. Elimina el parámetro "--project-id=<project-id>" y agrega el parámetro "--oas=<oas-url-or-path>". Por ejemplo: npx apifox-mcp-server --oas https://petstore.swagger.io/v2/swagger.json o npx apifox-mcp-server --oas ～/data/petstore/swagger.json

❓ Ayuda y soporte

Apifox MCP Server todavía está en fase de prueba interna. Te invitamos a darnos sugerencias e ideas. Únete al grupo de prueba interna: