O Apidog MCP Server permite que IDEs com tecnologia de IA, como o Cursor, acessem diretamente suas especificações de API e trabalhem com elas, acelerando o desenvolvimento e simplificando seu fluxo de trabalho.O Apidog MCP Server está atualmente em beta. Esta documentação será atualizada regularmente com novos recursos e melhorias.
Gerar código com base em suas especificações de API
Pesquisar e consultar o conteúdo das especificações de API
Atualizar DTOs com novos campos das especificações
Adicionar comentários de documentação ao código com base nas especificações de API
Criar código MVC completo para endpoints específicos
Como funciona#
Depois de configurado, o Apidog MCP Server lê e armazena automaticamente em cache todos os dados de especificação de API localmente. Então, a IA pode recuperar e utilizar esses dados de forma integrada.Basta dizer à IA o que você deseja realizar. Por exemplo:"Use MCP to fetch the API specification and generate Java records for the 'Product' schema and related schemas"
"Based on the API specification, add the new fields to the 'Product' DTO"
"Add comments for each field in the 'Product' class based on the API specification"
"Generate all the MVC code related to the endpoint '/users' according to the API specification"
As especificações de API são armazenadas em cache localmente. Se os dados no Apidog mudarem, peça à IA para atualizar, a fim de garantir que ela leia as atualizações mais recentes.
Pré-requisitos#
Antes de configurar o Apidog MCP Server, certifique-se de que você tenha:Node.js (versão 18 ou posterior, preferencialmente a versão LTS mais recente)
Uma IDE compatível com MCP:Outros editores compatíveis com MCP
Escolhendo sua fonte de dados#
O Apidog MCP Server oferece suporte a três fontes de dados diferentes. Selecione o método de configuração que corresponde às suas necessidades:Mais indicado para:Acessar especificações de API dentro da sua equipe no Apidog
Desenvolvimento de APIs privadas ou internas
Token de acesso pessoal à API do Apidog
Configuração de implantação on-premise#
Para implantações on-premise, adicione o endereço da API do seu servidor à configuração, independentemente da fonte de dados que você escolher:{
"mcpServers": {
"API specification": {
"command": "npx",
"args": [
"-y",
"apidog-mcp-server@latest",
"--apidog-api-base-url=<your-server-url>"
]
}
}
}
<your-server-url> pelo endereço da API do seu servidor on-premise (começando com http:// ou https://).Certifique-se de que seu ambiente consiga acessar www.npmjs.com corretamente.
Ajuda e suporte#
O Apidog MCP Server está atualmente em beta. Gostaríamos muito de receber seus comentários e sugestões!Participe da nossa comunidade: