Auto API - YApi

Serviço MCP YApi

Uma ferramenta de obtenção de informações de interface YApi baseada no Model Context Protocol (MCP)

🚀 Recursos

• 📋 Obter lista de interfaces: Obter lista de interfaces a partir da URL da página de categoria YApi
• 📝 Obter detalhes da interface: Obter informações detalhadas de requisição/resposta com base no ID da interface
• 🔧 Suporte a variáveis de ambiente: Suporte à configuração de informações de autenticação por meio de variáveis de ambiente
• 🛡️ Tratamento de erros: Tratamento de erros completo e mensagens de erro amigáveis ao usuário

Desenvolvimento local

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

🔧 Configuração

Crie o arquivo .env e adicione as informações de autenticação YApi (opcional):

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

Versão

node>18
npm 官方源

🎯 Uso no cliente MCP

Configuração do Cursor Desktop

Adicione em 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"
      }
    }
  }
}

Descrição das variáveis de ambiente:

• YAPI_TOKEN: Token de acesso do YApi (obrigatório)
• BASE_URL: URL base do serviço YApi (obrigatório)
• YAPI_COOKIE: Valor do Cookie para autenticação de requisições (opcional, alguns casos do YApi podem exigir)

📸 Como obter os parâmetros

🛠️ Ferramentas disponíveis

1. yapi_get_interfaces

Obtém a lista de interfaces sob uma categoria especificada

Parâmetros:

• url (string): URL da página de categoria YApi, no formato https://xxxxx.com/project/810/interface/api/cat_2783

Exemplo:

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

2. yapi_get_interface_detail

Obtém informações detalhadas da interface especificada (corpo da requisição e da resposta)

Parâmetros:

• id (string): ID da interface, proveniente do campo _id na lista de interfaces

Exemplo:

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

📖 Fluxo de uso

1. Obter lista de interfaces: Use yapi_get_interfaces para obter todas as interfaces da categoria
2. Obter detalhes da interface: Use yapi_get_interface_detail para obter informações detalhadas
3. Gerar definições de tipo: Gere tipos TypeScript com base no corpo de requisição/resposta retornado

📄 Licença

MIT

🤝 Contribuição

Contribuições são bem-vindas! Envie Issues e Pull Requests!

📧 Contato

Em caso de dúvidas, envie uma Issue ou entre em contato com o autor.