A interface Prosyst Web Endpoint permite testar endpoints de APIs REST de forma prática, com recursos para envio de requisições e visualização das respostas.

A tela está organizada em três painéis principais:

• Requisição: Configurações de envio (tipo, URL, headers, body).
• Resposta: Exibição de retorno e histórico de requisições.
• Favoritos: Gerenciamento de requisições salvas para reutilização.

Escolha o método HTTP desejado:

• GET: Consulta de dados
• POST: Envio de dados
• PUT: Atualização de dados
• DELETE: Exclusão de dados

Digite o endpoint da API no campo URL Base.

Exemplos:

• GET: http://localhost:5182/api/consultas/acabamento?codigo=29
• POST: http://localhost:5182/api/gravacoes/acabamento

Adicione os cabeçalhos clicando na tabela Header.

No caso de requisições como POST ou PUT, insira o corpo JSON da requisição.

Exemplo:

{
  "descricao": "API Teste Acabamento 2X",
  "quantidadePlanejamento": 8,
  "processoTerceirizacao": true,
  "sufixo": "TST"
}

No caso de requisições como GET, insira os parâmetros Query direto no link da URL, separando no formato:

➡️{url}?<color #00a2e8>parametro1</color>=<color #22b14c>valor1</color>&<color #00a2e8>parametro2</color>=<color #22b14c>valor2</color>&<color #00a2e8>parametro3</color>=<color #22b14c>valor3</color>

Exemplo:

• http://localhost:5182/api/consultas/acabamento?codigo=31

Clique no botão Enviar Request para executar a chamada e visualizar a resposta no painel central.

A resposta será exibida em formato JSON, com detalhes do sucesso da operação, dados retornados ou mensagens de erro.

Exemplo de retorno para GET:

{
  "bemSucedido": true,
  "mensagemFalha": null,
  "novoCodigo": null,
  "dados": [
    {
      "codigoAcabamento": 29,
      "descricao": "API Teste Acabamento 2X",
      "quantidadePlanejamento": 8,
      "processoTerceirizacao": true,
      "sufixo": "TST"
    }
  ]
}

Exemplo de retorno para POST:

{
  "detalhes": [
    "Acabamento gravado com sucesso!"
  ],
  "novoCodigo": "13"
}

A aba Favoritos, localizada à direita, permite salvar e organizar requisições reutilizáveis.

• Clique no botão Adicionar ✚ no rodapé da aba.
• Informe:
  • Descrição: Um nome amigável para a requisição.
  • TAG: Palavra-chave que facilite a categorização.

➡️ Ao sair da linha, a requisição atual (incluindo URL, tipo, headers e body) será armazenada como um favorito.

Se você alterou uma requisição salva e deseja regravar:

• Selecione a linha correspondente na lista de favoritos.
• Clique no botão de refresh 🔄 na própria linha.

Isso sobrescreverá o favorito com os novos dados preenchidos.

Se você deseja remover um favorito uma requisição salva e deseja regravar:

• Selecione a linha correspondente na lista de favoritos.
• Clique no botão Excluir ⛔.

O painel central também mostra um histórico de requisições recentes, com:

• Tipo da requisição (GET, POST, etc.)
• URL
• Código de retorno (ex: OK, InternalServerError)
• Data/hora da execução

Isso facilita depuração e repetição de testes.