Postman para testar Api do TMDB

Postman ajuda você a ser extremamente eficiente ao trabalhar com APIs, com ele você pode construir solicitações rapidamente, guardá-las para uso posterior e analisar as respostas enviadas pelo API. Postman pode reduzir drasticamente o tempo necessário para testar e desenvolver APIs.

Acessar o site do Postman e realizar o download compatível com seu sistema operacional.

64bits

Instalação

Clicar no arquivo executável e seguir os passos de instalação.

Image for post

Com a facilidade do uso do mesmo login do Google, usar sua conta.

Image for post

Para saber mais sobre o

Postman consulte a documentação oficial neste Link.

Testando a API do TMDb

Usaremos a API da Movie Database em nossos testes, que é um banco de dados de filmes e TV criado pela comunidade. Para isto, precisaremos criar uma conta, acesse o endereço:

https://www.themoviedb.org/login?language=pt-BR

Após criar a conta, acesse Configurações > API e anote as informações de Chave da API e o Token de Leitura da API, precisaremos delas mais tarde.

Image for post

Consulte sempre a documentação da API através deste Link.

Conhecendo os componentes do Postman

A seguir apresentarei alguns componentes do Postman de uma forma prática.

Workspace

Nosso primeiro passo será criar um Workspace, que é um recurso que ajuda a organizar o trabalho. Podemos separar nossos projetos por clientes, orgizando em espaços de trabalho de acordo com o contexto do projeto que está testando. Também possível compartilhar espaços de trabalho com sua equipe, o que permite a colaboração em tempo real.

Image for post

Para criar nosso Workspace, selecione Create New, vamos chamá-lo de TMDb API Test.

Image for post
Image for post

Collection

Depois de criar nosso Workspace, vamos criar uma collection, que permite o agrupamento de diferentes solicitações, organizando essas solicitações em “pastas”. Para criar uma collection, clique em New Collection:

Image for post

Dê um nome para a collection:

Image for post

As collections são muito úteis, pois facilitam a organização e a documentação de suas requisições. Você pode criar conjuntos de testes, anexando scripts de teste a requisições e construir conjuntos de testes de integração.

Environment

Um environment é um conjunto de variáveis ​​que permite alternar o contexto de suas solicitações. As variáveis ​​permitem armazenar e reutilizar valores em suas solicitações e scripts.

Image for post

Vamos inserir a URL base do TMDb (https://api.themoviedb.org/3 ) , a api_key e o token dentro de variáveis, para que possamos reutilizá-la em todos os requests:

Image for post
Image for post

Primeiro Request

Vamos criar agora nosso primeiro request. Será um GET que retorna os filmes mais bem avaliados na plataforma.

Siga os passos abaixo para criar um novo request:

Image for post
Image for post

A URI desse request é:

https://api.themoviedb.org/3/movie/top_rated

Como a URL base já está na nossa environment, parassaremos o nome da variável seguindo a notação {{baseUrl}}

{{baseUrl}}/movie/top_rated

Image for post

Vamos inserir também os headers necessários, e clicar em Send para efetuar o request:

Image for post

Agora recebemos a resposta da API, com os filmes top-rated e suas informações no formato JSON. Destaquei um filme (ótimo filme, por sinal) para que possamos identificar seu bloco no retorno:

Image for post
GET /movie/top_rated

Adicionando mais requests

Para saber quais as possibilidades de requests que podemos fazer nessa API, consulte a documentação em https://developers.themoviedb.org/3 , conforme a imagem abaixo:

Image for post

Vamos adicionar mais requests em nossa collection.

Image for post
GET /discover/movie
Image for post
GET /movie/popular

Podemos utilizar Query Params para realizar filtros e buscar um filme específico. Devemos passar também o parâmetro api_key, como solicitado na documentação (https://developers.themoviedb.org/3/search/search-movies). Vamos fazer um filtro, buscando pelo título Batman:

Image for post
Query params
Image for post
GET /search/movie

Sandbox e Test Scripts

Com o Postman é possível escrever scripts de teste para suas solicitações da API usando JavaScript. O Postman Sandbox é um ambiente de execução JavaScript disponível para você ao escrever scripts de pré-request e scripts de teste para solicitações. Vamos adicionar alguns testes básicos em nossos requests:

  • Status-Code: queremos que nossas requisições retornem 200 (Sucesso).
  • Validar se Content-Type e Connection são retornados no Response Header.

Insira o código abaixo na aba Tests:

// Valida status code
pm.test(“Status test”, function () {
pm.response.to.have.status(200);
});// Valida se Content-Type é retornado no Response Header
pm.test(“Content-Type header is present”, function () {
pm.response.to.have.header(“Content-Type”);
});// Valida se Connection é retornado no Response Header
pm.test(“Connection header is present”, function () {
pm.response.to.have.header(“Connection”);
});
Image for post

Na aba Test Results podemos ver os resultados dos testes:

Image for post

Os testes permitem garantir que sua API esteja funcionando conforme o esperado, estabelecer que as integrações entre os serviços estejam funcionando de maneira confiável e verificar se os novos desenvolvimentos não quebraram nenhuma funcionalidade existente.

Collection Runner

Como vimos anteriormente, as collections são grupos de requisições que podem ser executados. Com o Runner podemos criar suítes de teste de integração usando scripts de teste e automatizar sua execução.

Vamos executar os testes usando o Runner:

Image for post

Selecione a collection e environment desejadas, e clique em Run:

Image for post

Os testes serão exibidos em Run Results:

Image for post

Newman

O Newman é utilizado para executar o Runner do Postman via linha de comando. Ele é construído com a extensibilidade em mente, para que você possa integrá-lo facilmente aos seus servidores de Integração Contínua.

Para instalar o Newman, consulte a documentação em: https://www.npmjs.com/package/newman

Pra finalizar esse post (que já ficou MUITO longo), vamos executar o Runner pela linha de comando usando o Newman:

  • Primeiro exporte sua collection, e salve em um diretório com seus testes:
Image for post
Image for post
  • Depois exporte suas environments e salve no mesmo diretório:
Image for post

Para executar, abra o terminal e navegue até o diretório que salvamos as collections e environments. O comando para executar o newman é:

$ newman run SUA_COLLECTION --environment SUA_ENVIRONMENT
Image for post

O Newman exibirá todos os relatórios no próprio terminal.

Assim finalizamos nossos testes com Postman, lembrando que existem diversas possibilidades, e o intuito deste post foi exibir apenas algumas delas e lembrando que tanto a newman quanto o runner funcionam também com o Insomnia.

0 Reviews

Write a Review

Rodrigo Rangel

Read Previous

Afinal, o que API

Read Next

Postman vs. Insomnia: Comparando as Ferramentas de Teste de API

Leave a Reply

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

WhatsApp chat