Utilizar a documentação de forma eficaz

Este guia explica como qualquer pessoa — desenvolvedores, produto, suporte ou integração — pode utilizar a documentação da API, com foco em:

Como utilizar o recurso Testar diretamente na documentação

Integrar a documentação com IDEs assistidas por IA via MCP Server (Model Context Protocol)

1. ✨ Usando o "Testar" na documentação da API

A documentação inclui um recurso interativo chamado "Testar", que permite testar os endpoints diretamente da documentação, sem precisar abrir Postman, Insomnia ou terminal.

1.1. Como usar

Abra a página de um endpoint

Clique no botão Testar

Preencha os campos conforme o caso:

Query Params

Body

Headers

Auth

Clique em Enviar e veja:

Request enviada

Response body

Headers

Status code

1.2. Dicas importantes

Certifique-se de configurar a autenticação antes (Username: DNS, Password: Token).

Utilize valores válidos para evitar erros.

Ótimo para validar comportamento real de endpoints.

2. ⚙️ Integração com IA via MCP Server da documentação

Permita que IDEs como Cursor acessem automaticamente a documentação da API.

A documentação oferece um servidor MCP (Model Context Protocol) que permite que ferramentas como Cursor e VS Code + extensões MCP acessem diretamente:

A especificação da API

A documentação publicada

Esquemas

Endpoints

Componentes

Autenticação

Exemplos

Ou seja: a IA dentro da IDE consegue ler e usar toda a sua API para gerar código automaticamente.

2.1. O que o MCP Server permite fazer?

Com o MCP da Apidog, você pode:

Gerar código pronto baseado em qualquer endpoint

Atualizar DTOs automaticamente

Criar serviços, controllers, rotas e chamadas de API

Inserir comentários baseados na documentação

Procurar endpoints pela descrição

Validar requisições

Criar testes baseados no schema

E muito mais — tudo sem copiar e colar documentação manualmente!

A IA passa a ter memória local da sua API.

2.2. Como funciona?

O MCP Server:

Baixa e cacheia localmente toda a documentação da API

A IA da sua IDE acessa esses dados nativamente

Você só pede:

“Gere o serviço para o endpoint /appointments/schedule/detail usando o schema da API.”

E o Cursor / VSCode gera TUDO automaticamente.

2.3. Configuração com 1 clique

Você pode configurar com o JSON abaixo.

Este exemplo usa o site ID 759651:

{
  "mcpServers": {
    "EVO API": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=759651"
      ]
    }
  }
}

📌 Requisitos:

Node.js >= 18

IDE com suporte a MCP:

Cursor

VS Code (via plugins como Cline ou AI MCP)

2.4. Configuração manual (caso queira personalizar)

Você pode ajustar:

Portas

Cache

Access tokens (para docs privadas)

Fonte dos dados (OpenAPI / Swagger / docs online .txt)

Exemplo

Ou, se for ambiente On-Premise:

2.5. O que fazer após colar o JSON?

No Cursor ou VSCode:

Abra Settings → MCP Servers

Cole o JSON acima

Reinicie a IDE

A IA passa a responder com base na documentação real:

Exemplo de prompt útil:

“Use o MCP para buscar o schema de Sales e gerar uma classe TypeScript com tipagem completa.”

2.6. Documentação oficial do MCP Server

A Apidog, fornecedora da hospedagem da documentação da EVO API, mantém documentação completa sobre:

Como funciona o MCP

Como conectar projetos

Como usar documentação publicada como fonte

Como conectar Swagger / OpenAPI

Ler referência completa.

Utilizar a documentação de forma eficaz

1. ✨ Usando o "Testar" na documentação da API#

1.1. Como usar#

1.2. Dicas importantes#

2. ⚙️ Integração com IA via MCP Server da documentação#

2.1. O que o MCP Server permite fazer?#

2.2. Como funciona?#

2.3. Configuração com 1 clique#

📌 Requisitos:#

2.4. Configuração manual (caso queira personalizar)#

Exemplo#

2.5. O que fazer após colar o JSON?#

2.6. Documentação oficial do MCP Server#