Apifox MCP Server

Apifox MCP Server

Usando o Apifox MCP Server, você pode fornecer a documentação de interface dentro de projetos Apifox como fonte de dados para IDEs que suportam programação com IA, como Cursor, permitindo que a IA acesse diretamente os dados da documentação de interface do projeto correspondente.

Os desenvolvedores podem usar o assistente de IA para concluir as seguintes tarefas: gerar ou modificar código com base na documentação de interface, pesquisar conteúdo da documentação de interface, etc. Quanto ao que mais poderoso você pode fazer com esses dados de documentação de interface, use a imaginação sua e da sua equipe😜

🎯 Como usar

Após instalar e configurar o MCP, o Apifox MCP Server lerá automaticamente todos os dados da documentação de interface de todo o projeto Apifox e os armazenará em cache no computador local. A IA pode ler os dados da documentação de interface de todas as interfaces do projeto através do MCP.

Basta dizer à IA o que você deseja fazer com a documentação da API, por exemplo:

1. "Obtenha a documentação da API via MCP e gere o código de definição para Product e seus modelos relacionados"
2. "Com base na documentação da API, adicione os novos campos da documentação da API ao Product DTO"
3. "Com base na documentação da API, adicione comentários a cada campo da classe Product"
4. "Com base na documentação da API, gere todo o código MVC relacionado à interface /users"

Observação: os dados da documentação de interface são armazenados em cache localmente por padrão. Se os dados no Apifox forem atualizados, informe à IA para atualizar os dados da documentação de interface; caso contrário, os dados lidos pela IA podem não estar atualizados.

🚀 Método de instalação

Pré-requisitos

• Ambiente Node.js instalado (versão >= 18, recomendamos a versão LTS mais recente)
• Qualquer IDE que suporte MCP:
  • Cursor
  • VSCode + plugin Cline

Instalação

1. Gerar Access Token no Apifox a. Abra o Apifox, passe o mouse sobre o avatar no canto superior direito da página e clique em "Configurações da conta -> Token de acesso à API" b. Crie um novo token de acesso à API; consulte a documentação de ajuda para mais detalhes c. Obtenha o token de acesso à API e substitua o <access-token> no arquivo de configuração abaixo
2. Obter o ID do projeto Apifox a. Abra o projeto correspondente no Apifox b. Clique em "Configurações do projeto" na barra lateral esquerda e copie o ID do projeto na página "Configurações básicas" c. Obtenha o ID do projeto e substitua o <project-id> no arquivo de configuração abaixo
3. Configurar a IDE

Adicione a seguinte configuração JSON ao arquivo de configuração MCP correspondente da IDE:

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

Se você estiver usando o sistema operacional Windows e o arquivo de configuração acima não funcionar corretamente, use o seguinte arquivo de configuração:

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

• Cursor: adicione ao ~/.cursor/mcp.json global ou ao .cursor/mcp.json do projeto
• Cline: abra o painel Cline > MCP Server > Configure MCP Server

Observações:

1. Substitua o <access-token> e o <project-id> acima pelo seu token de acesso à API Apifox pessoal e pelo ID do projeto Apifox.
2. Recomenda-se que o nome do MCP Server no arquivo de configuração seja algo como "Documentação da API" ou "Documentação da API xxx", contendo as palavras "Documentação da API", para que a IA identifique mais facilmente a finalidade deste MCP Server. Não é recomendado usar "Apifox" ou "Apifox MCP", pois a IA não identifica facilmente a finalidade dessa forma.
3. Se precisar usar a documentação da API de vários projetos, adicione vários MCP Servers no arquivo de configuração (projetos diferentes têm <project-id> diferentes) e nomeie os MCP Servers como "Documentação da API xxx".
4. Se a sua equipe costuma sincronizar o arquivo de configuração MCP no repositório de código, recomendamos remover o "APIFOX_ACCESS_TOKEN": "<access-token>" da configuração e, em vez disso, cada membro configura uma variável de ambiente chamada APIFOX_ACCESS_TOKEN no seu próprio computador, para evitar o vazamento do APIFOX_ACCESS_TOKEN.
5. Usuários da versão de implantação privada, adicione o parâmetro no arquivo de configuração MCP da IDE: "--apifox-api-base-url=<私有化部署服务器的 API 地址，以 http:// 或 https:// 开头>". Além disso, garanta que a rede possa acessar www.npm.com normalmente.
6. Além de projetos Apifox, também é suportada a leitura direta de arquivos Swagger/OAS. Remova o parâmetro "--project-id=<project-id>" e adicione o parâmetro "--oas=<oas-url-or-path>". Por exemplo: npx apifox-mcp-server --oas https://petstore.swagger.io/v2/swagger.json ou npx apifox-mcp-server --oas ～/data/petstore/swagger.json

❓Ajuda e suporte

O Apifox MCP Server ainda está em fase de testes internos. Envie suas sugestões e ideias para nós; junte-se ao grupo de testes internos: