Tempo aproximado para leitura: 00:03:17 min
Dúvida
Como utilizar o POSTMAN para consultas REST?
Ambiente
Framework - Framework (Linha Datasul) - Tomcat - Todas as versões
Solução
O POSTMAN é uma ferramenta muito útil para, dentre outras atividades, testar se os servidores de aplicação estão funcionais. Com ela é possível validar as respostas de consultas REST - Representational State Transfer.
Para obter essa ferramenta basta fazer o seu download com o link disponibilizado no item Saiba mais.
Após a sua instalação, fazer o login na ferramenta. Para facilitar é possível utilizar o login da conta Google.
Nesta ferramenta você organiza as suas chamadas REST dentro de Coleções. Primeiro você cria uma Collection dentro da sua Workspace. Por exemplo, você poderá criar uma coleção para armazenar as consultas REST da TOTVS e outra para armazenar consultas REST disponíveis pelo PASOE - Progress Application Server for OpenEdge. No item Saiba mais você encontra referência para algumas destas consultas.
Criada a Collection, o próximo passo é criar dentro dela as requisições. Cada requisição corresponde a uma consulta a uma API REST. Dentro da Collection, utilizar a opção Add Request. Informar um nome para esta requisição bem como o endereço a ser consultado, a forma de autenticação e parâmetros opcionais que cada API pode solicitar. Salvar esta requisição para que possa ser reutilizada no futuro.
O botão send é responsável por executá-la. No exemplo a seguir é realizada a consulta a uma API padrão do produto Datasul, para ilustrar o uso desta ferramenta.
Aqui é criada uma Collection com o nome DATASUL, centralizando nela algumas consultas do produto Datasul:
Dentro desta coleção, clique em add request e informe o nome da API, neste exemplo, 4glParams:
Informe o endereço desta API, neste nosso exemplo, o endereço é:
http://<servidor-tomcat>:<porta>/api/utp/v1/4glParams
Informe o tipo de autenticação básico, informando o usuário e senha do produto Datasul:
Clique em salvar, para preservar os dados. Para executar, clique no botão enviar, ou send:
O resultado será o código 200 informando que o retorno foi com sucesso, ou o código do erro ocorrido. Na parte inferior será apresentado o resultado da consulta ou detalhes do erro informado pelo servidor de aplicação.
Em ambiente Linux o nome do programa é sensível ao case.
Saiba mais
Aqui você encontra links para informações complementares ao artigo:
Instalador do PostMan
Framework - Linha Datasul - TEC - Como consultar métricas de acesso ao PASOE via API REST
0 Comentários