Auto API - YApi

Servicio MCP de YApi

Una herramienta para obtener información de interfaces de YApi basada en Model Context Protocol (MCP)

🚀 Características

• 📋 Obtener lista de interfaces: Obtener la lista de interfaces según la URL de la página de categoría de YApi
• 📝 Obtener detalles de la interfaz: Obtener información detallada del cuerpo de solicitud/respuesta según el ID de la interfaz
• 🔧 Soporte de variables de entorno: Permite configurar información de autenticación mediante variables de entorno
• 🛡️ Manejo de errores: Manejo de errores completo y mensajes de error amigables para el usuario

Desarrollo local

git clone https://github.com/twelve-web/yapi-mcp.git
cd yapi-mcp
npm install
npm run build

🔧 Configuración

Cree el archivo .env y agregue la información de autenticación de YApi (opcional):

YAPI_TOKEN=""
BASE_URL=""
YAPI_COOKIE=""  # 可选，用于需要Cookie认证的场景

Versión

node>18
npm 官方源

🎯 Uso en clientes MCP

Configuración de Cursor Desktop

Agregue en mcp.json:

{
  "mcpServers": {
    "auto-yapi-mcp": {
      "command": "npx",
      "args": ["-y", "auto-yapi-mcp"],
      "env": {
        "YAPI_TOKEN": "aa270a5a35f043540xxxxxxx5c908164f6fcae",
        "BASE_URL": "https://fed.xxxx.com",
        "YAPI_COOKIE": "your_cookie_value_here"
      }
    }
  }
}

Descripción de variables de entorno:

• YAPI_TOKEN: Token de acceso de YApi (obligatorio)
• BASE_URL: URL base del servicio de YApi (obligatorio)
• YAPI_COOKIE: Valor de cookie para autenticación de solicitudes (opcional, algunos casos de YApi pueden requerirlo)

📸 Cómo obtener los parámetros

🛠️ Herramientas disponibles

1. yapi_get_interfaces

Obtener la lista de interfaces bajo la categoría especificada

Parámetros:

• url (string): URL de la página de categoría de YApi, con formato como https://xxxxx.com/project/810/interface/api/cat_2783

Ejemplo:

工具: yapi_get_interfaces
参数: url = "https://xxxxx.com/project/810/interface/api/cat_2783"

2. yapi_get_interface_detail

Obtener información detallada de la interfaz especificada (cuerpo de solicitud y respuesta)

Parámetros:

• id (string): ID de la interfaz, del campo _id en la lista de interfaces

Ejemplo:

工具: yapi_get_interface_detail
参数: https://xxxxxxx/project/1219/interface/api/42726

📖 Flujo de uso

1. Obtener lista de interfaces: Use yapi_get_interfaces para obtener todas las interfaces de la categoría.
2. Obtener detalles de la interfaz: Use yapi_get_interface_detail para obtener información detallada.
3. Generar definiciones de tipos: Genere tipos de TypeScript basados en el cuerpo de solicitud/respuesta devuelto.

📄 Licencia

MIT

🤝 Contribuciones

¡Bienvenidos a enviar Issues y Pull Requests!

📧 Contacto

Si tiene algún problema, envíe un Issue o contacte al autor.