Realizando requisições no Postman

Atualmente, acessar APIs é algo que está no cotidiano de todo desenvolvedor Web. Por isso é muito importante sabermos como alterar e consultar dados, seja adicionando, editando ou excluindo. Uma ótima forma de fazer isso é usando aplicações que fazem as requisições e exibem o resultado, deixando o trabalho bem mais prático. Nesse artigo vamos aprender como fazer requisições no Postman, mas também funciona com outras ferramentas.

Primeiros Passos

Instalando o Postman

Primeiramente, precisamos instalar a ferramenta principal, o Postman. Acesse o site oficial, faça o Download e instale o executável padrão do Windows.

Criando um projeto

Em seguida, vamos precisar também do json-server. Já que essa ferramenta cria uma API simples em JSON, ela vai nos ajudar a fazer os testes sem precisarmos implementar uma API do zero.

Para criar um novo projeto para nossa API, vamos criar uma pasta e, dentro dela, usaremos o terminal para digitar o seguinte comando:

$ npm init -y

Com esse comando criaremos o package.json. Esse arquivo contém metadados relacionados ao projeto e nele encontraremos as seguintes informações: nome do projeto local, versão, licença, dependências e as versões que são usadas no projeto.

O próximo passo é instalar a dependência json-server digitando o seguinte comando no terminal:

$ npm i -s json-server

Com isso, o seu package.json deverá ficar assim:

{
  "name": "requisicoes",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "json-server": "^0.16.2"
  }
}

Finalmente, para rodar o nosso projeto, precisamos declarar um script de execução. Dessa forma, ao invés de ficarmos digitando um comando extenso no terminal, podemos criar um “apelido” a esse comando e simplesmente invocá-lo a partir do apelido. Para fazermos isso, basta acessar o arquivo package.json e substituir o trecho scripts pelo seguinte:

"scripts": {
    "dev": "json-server --watch db.json --port 3004"
}

Feito isso, ao executarmos o json-server, será criado um arquivo chamado db.json. Esse arquivo é o nosso “banco de dados”. Você pode criar o cenário que preferir, seguindo o padrão json. Por padrão, o arquivo ficará da seguinte forma:

{
  "posts": [
    {
      "id": 1,
      "title": "json-server",
      "author": "typicode"
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "some comment",
      "postId": 1
    }
  ],
  "profile": {
    "name": "typicode"
  }
}

O json-server disponibiliza uma série de funções internas que permitem você manipular a API através de chamadas HTTP, para que assim possamos acessar e modificar esses dados.

Logo em seguida, criaremos uma espécie de lista de alunos, que possuem: id, nome e nota. A estrutura final será essa:

{
  "alunos": [
    {
      "id": 1,
      "nome": "Christian",
      "nota": 10
    },
    {
      "id": 2,
      "nome": "João",
      "nota": 7
    }
  ]
}

Em resumo, usamos o json-server para criar um endpoint com base nos objetos que estão dentro do db-json. De tal forma que, se tivéssemos mais objetos, teríamos mais URLs de acesso a nossa aplicação. Como o Endpoint é a URL que vamos usar para acessar a nossa API, no meu caso eu vou acessar a partir de localhost:3004/alunos.

Conceitos Básicos do Postman

Antes de seguirmos com o projeto, vamos entender alguns conceitos básicos e fundamentais do Postman.

Adicionando a URL

Antes de mais nada, é importante saber onde enviar as requisições no Postman. Faremos isso na barra central no Postman, onde colocaremos a URL que vamos acessar e a porta que definimos para execução.

Modificando o tipo de requisição

O próximo passo é aprendermos como modificar o tipo da requisição, pois dessa forma poderemos transitar entre as requisições testes do projeto.

Para que possamos saber quais as possíveis requisições no Postman, clique no botão ao lado da barra de URL e ele exibirá uma lista. É importante ficar atento para sempre colocar o tipo de requisição correta, pois do contrário não irá funcionar.

Body

É no Body da requisição que colocamos os valores que vamos inserir ou editar na API, como o nome, por exemplo.

Podemos definir o valor do Body de diversas formas e uma delas é utilizando o padrão de chave e valor. Primeiramente, vamos colocar o nome da propriedade que queremos enviar no campo key. Em seguida, vamos colocar o valor da propriedade dentro do campo value. Se você quiser remover alguma propriedade, basta apagar ou clicar no botão ao lado do campo da chave.

Outra forma é usar o Bulk Edit, pois a partir dele podemos adicionar uma série de valores em um campo de texto, sendo bem mais rápido. Para isso, basta identificar o nome da propriedade e seu valor, como na imagem abaixo:

requisições no Postman

Dito isso, já podemos começar a entender um pouco mais sobre a teoria e prática das quatro requisições no Postman: Get, Post, Put e Delete. Vamos lá!

GET

É a requisição mais básica e a mais utilizada, pois a partir dela conseguimos recuperar os dados presentes na API de forma simples. Como mostro na imagem abaixo, ele irá exibir os dados dentro do Body da resposta.

Não tem muito mistério, precisamos apenas indicar qual a URL vamos acessar e, se tivermos permissão, a requisição será feita normalmente.

POST

Vamos usar o POST sempre que precisarmos inserir novos dados na API, porque é com ele que indicamos os valores que iremos adicionar.

Mas antes disso, é preciso trocar o tipo de requisição, para que não ocorra um erro na chamada da API. No meu exemplo, não importa o nome da propriedade que eu vou colocar, pois estou usando o json-server. Por outro lado, em projetos reais existem algumas propriedades obrigatórias. Fique atento a isso.

Vamos voltar para o Body da requisição e colocar aqui os valores que iremos inserir na API. No caso, vou adicionar um novo registro com um nome e nota, seguindo o exemplo proposto.

Logo após enviar a requisição que adiciona os novos valores, vamos trocar o tipo de requisição para GET e observar como ficou o estado da nossa API.

PUT

É a requisição responsável por modificar os dados da API. Para realizá-la precisamos (novamente) mudar o tipo de requisição e declarar a URL. No entanto, com um pequeno diferencial: precisamos também definir qual dado iremos modificar e só então passamos o id referente

Nesse caso, eu utilizei uma forma de adicionar o id sem declarar o seu valor diretamente na URL. Isso é ótimo, porque assim não deixo informações importantes na URL, por questões de segurança. Para fazer isso, basta colocar :id.

Ao adicionar essa diretiva, vai surgir uma aba abaixo para colocar o valor referente ao id. No meu caso, foi o valor 3. Feito isso, temos que dizer no Body qual modificação iremos realizar. É bem parecido com o POST, no entanto aqui queremos modificar um valor já existente.

Na imagem acima, modifiquei o nome e nota com os valores que passamos. Então, depois de ter enviado a requisição (PUT), podemos ver se foi realmente modificado, e para fazer isso vamos trocar o tipo para GET.

DELETE

Por fim, chegamos na última requisição. Essa já é autoexplicativa, pois é responsável por deletar um valor na API. Para realizar essa requisição, precisamos modificar o tipo da requisição e definir qual id do registro iremos remover, como na imagem abaixo:

Eu optei por colocar o id diretamente na URL, mas é possível usar a mesma solução que mostrei no PUT. Agora, se puxarmos novamente a lista de usuários, ele apresentará o seguinte:

Considerações Finais

Agora você já sabe um pouco de requisições no Postman e como funcionam algumas requisições HTTP. Você vai ver na prática como esse conhecimento pode te ajudar, já que consultar APIs é muito recorrente no dia a dia de um programador.

Bons estudos!

Links Úteis

• Json-Server
• Postman