O que é Postman?
É uma ferramenta de suporte à documentação das requisições feitas pela API REST com os principais métodos HTTP seguintes:
- GET: Utilizado para obter um recurso
- POST: Utilizado para cadastrar uma informação
- PUT: Utilizado para alterar um recurso
- DELETE: Utilizado para deletar um recurso
Instalando o Postman
Faça o Download do Postman , conforme o SO e arquitetura.
No Windows, basta executar o arquivo executável e seguir os padrões de costume de Windows.
No Linux, extrair o arquivo Postman-linux64-tar.gz, conforme segue:
Extrair o arquivo Postman
$ tar -xzvf Postman-linux64-tar.gz Acessar o diretório
$ cd Postman Executar o binário
$ ./Postman PS: Pode criar um atalho para abrir o Postman no gerenciador gráfico que estiver utilizando na distro também.
Tendo instalado o Postman no computador, a URL da API e os endpoints, pode já começar a utilizar a fazer as requisições.
Por convenção de boas práticas, utiliza versionamento na API REST, assim a URL ficaria algo assim https://api.dominio.com/v1/ seguido pelo nome do endpoint.
Geralmente a API REST tem algum método de autenticação, seja, Basic Auth (autenticação básica), API Key, Bearer Token (JWT), entre outros listados, conforme pode verificar no Postman na aba Authorization em Type.
Após selecionar o método de autenticação utilizado pela API REST, informe o campo correspondente, conforme o método selecionado.
Se selecionar Basic Auth, irá aparecer dois campos Username e Password.
Se selecionar Bearer Token, irá aparecer o campo Token, que corresponde ao JWT.
Assim sucessivamente para outros métodos de autenticação disponíveis.
O próximo é selecionar o método HTTP e a URL da API com o endpoint
Exemplo de requisição GET
URL fictícia: https://api.dominio.com
Endpoint: /produtos
Método HTTP: GET
Se quiser consultar todos os registros de produtos da API do exemplo. Nesse caso, selecione GET, coloque a URL da API com o endpoint produtos e clique no botão "Send", irá obter o resultado. geralmente um JSON como resposta com a listagem de produtos da API.
Caso deseja obter apenas um registro específico, então após o endpoint, adicione o id que é o identificador único.
URL fictícia: https://api.dominio.com
Endpoint: /produtos
identificador único que deseja buscar: 8
Método HTTP: GET
No Postman, a URL ficaria assim https://api.dominio.com/produtos/8
Exemplo de requisição POST
Para facilitar o processo, evitando ter que colocar o método de autenticação da API novamente na próxima requisição, nesse caso POST, passa sobre o mouse no nome da requisição em 3 pontinhos, vai em Duplicate, assim será duplicado, bastando apenas alterar o método HTTP, nesse caso de GET para POST e apagar o identificador único, colocando a URL real e o endpoint da API.
URL fictícia: https://api.dominio.com
Endpoint: /produtos
Método HTTP: POST
Na aba Body, selecione form-data, preenche os campos Key (nome do campo), Value (o conteúdo correspondente ao campo).
Faz isso para cada campo, após concluir, clique no botão "Send", que irá obter um retorno em JSON, algo como "Cadastrado com sucesso" e com status 200 ou 201.
Exemplo de requisição PUT
Repita o procedimento explicado anteriormente para duplicar o requição anterior, assim altere o método HTTP de POST para PUT.
URL fictícia: https://api.dominio.com
Endpoint: /produtos
Método HTTP: PUT
Na aba Body, selecione form-data, preenche os campos Key (nome do campo), Value (o conteúdo correspondente ao campo).
O método PUT é semelhante ao POST, com a diferença que é para atualizar o registro no endpoint, então precisa informar o identificador único para que seja atualizado apenas no id específico.
Informe na URL com o endpoint da API no final o identificador único. A URL ficaria assim https://api.dominio.com/produtos/8. Nesse caso o identificador seria o 8, mas pode ser o que quiser, você escolhe.
Faz isso para cada campo, após concluir, clique no botão "Send", que irá obter um retorno em JSON, algo como "Cadastrado com sucesso" e com status 200 ou 201.
Exemplo de requisição DELETE
Repita o procedimento explicado anteriormente para duplicar o requição anterior, assim altere o método HTTP de PUT para DELETE.
URL fictícia: https://api.dominio.com
Endpoint: /produtos
Método HTTP: DELETE
O método DELETE, como o próprio nome já diz, serve para excluir registro no endpoint da API, então precisa informar o identificador único para que seja excluído apenas no id específico. Informe na URL com o endpoint da API no final o identificador único. A URL ficaria assim https://api.dominio.com/produtos/8. Nesse caso o identificador seria o 8, mas pode ser o que quiser, você escolhe.
Apague o que estiver na aba Body os campos com os valores e clique no botão "Send", irá obter um retorno JSON, que foi excluído com sucesso ou falha, isso se quem o desenvolveu a API adicionou um retorno, geralmente tem, mas em todo caso, tem o status 200.
Considerações finais
Nesse post foi apresentado a descrição breve, instalação e modo de utilizar o Postman para utilizar na requisição de API REST de terceiros ou na sua própria que desenvolveu. Para saber mais sobre o status HTTP .
Feito!
