O Apidog MCP Server permite que IDEs com tecnologia de IA, como o Cursor, acedam diretamente às suas especificações de API e trabalhem com elas, acelerando o desenvolvimento e simplificando o seu fluxo de trabalho.O Apidog MCP Server encontra-se atualmente em versão beta. Esta documentação será atualizada regularmente com novas funcionalidades e melhorias.
Gerar código com base nas suas especificações de API
Pesquisar e consultar conteúdo de especificações de API
Atualizar DTOs com novos campos provenientes 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 coloca automaticamente em cache, localmente, todos os dados das especificações de API. A IA pode então obter e utilizar estes dados de forma integrada.Basta dizer à IA o que pretende 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 colocadas em cache localmente. Se os dados no Apidog forem alterados, peça à IA para atualizar, de modo a garantir que lê as atualizações mais recentes.
Pré-requisitos#
Antes de configurar o Apidog MCP Server, certifique-se de que tem:Node.js (versão 18 ou posterior, de preferência a versão LTS mais recente)
Um IDE compatível com MCP:Outros editores com suporte para MCP
Escolher a sua fonte de dados#
O Apidog MCP Server suporta três fontes de dados diferentes. Selecione o método de configuração que corresponde às suas necessidades:Mais indicado para:Aceder a especificações de API dentro da sua equipa Apidog
Desenvolvimento de APIs privadas ou internas
Token de acesso pessoal à API do Apidog
Configuração de implementação on-premise#
Para implementações on-premise, adicione o endereço da API do seu servidor à configuração, independentemente da fonte de dados que 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 por http:// ou https://).Certifique-se de que o seu ambiente consegue aceder corretamente a www.npmjs.com.
Ajuda e suporte#
O Apidog MCP Server encontra-se atualmente em versão beta. Gostaríamos muito de receber os seus comentários e sugestões!Junte-se à nossa comunidade: