Realizando testes em Web Services ou APIs em Formato JSON

---

Objetivo

Realizar os testes de API  por meio de ferramentas disponíveis gratuitamente, visamos identificar o funcionamento da API para dimensionar a utilização integrada com os serviços Tactium.

Ferramenta de testes JSON

Para realizar testes JSON recomendamos utilizar uma extensão do Chrome chamada de “Swagger Inspector“.  Trata-se de uma aplicação open source que auxilia desenvolvedores nos processos de definir, criar, documentar e consumir APIs REST.  Em suma, o Swagger visa padronizar este tipo de integração, descrevendo os recursos que uma API deve possuir, como endpoints, dados recebidos, dados retornados, códigos HTTP e métodos de autenticação, entre outros.

Como o Swagger é uma extensão do Google Chrome, ele pode ser facilmente encontrado na “Chrome Web Store” do navegador do Google. Para facilitar o acesso você poderá baixa a extensão utilizando o link abaixo: https://inspector.swagger.io/builder

Outras aplicações semelhantes são o Postman, um dos maiores hosts públicos de API’s do mundo e o Testfully uma alternativa ao primeiro.

Swagger Inspector

Antes de iniciar é necessário que você conheça como funciona o Web Service que está prestes a testar, caso necessário solicite a documentação ao fornecedor do Web Service ou API antes de começar.

Depois que você baixar e instalar a extensão a mesma ficará disponível no seu navegador, basta clicar no ícone que fico no canto superior direito da tela, ao lado da barra de endereço. Em seguida clicar no Swagger, conforme ilustrado na imagem abaixo:

Utilização

Ao abrir a extensão será exibida a seguinte tela.

Métodos

Como podemos ver ao clicar na lista que fica do lado esquerdo da tela, o Swagger é bastante versátil e pode consumir diversos tipos de métodos.

GET	O método GET solicita a representação de um recurso específico. Requisições utilizando o método GET devem retornar apenas dados.
POST	O método POST é utilizado para submeter uma entidade a um recurso específico, frequentemente causando uma mudança no estado do recurso ou efeitos colaterais no servidor.
PUT	O método PUT substitui todas as atuais representações do recurso de destino pela carga de dados da requisição.
DELETE	O método DELETE remove um recurso específico.
PATCH	O método PATCH é utilizado para aplicar modificações parciais em um recurso.
HEAD	O método HEAD solicita uma resposta de forma idêntica ao método GET, porém sem conter o corpo da resposta.
OPTIONS	O método OPTIONS é usado para descrever as opções de comunicação com o recurso de destino.

Parâmetros

Os parâmetros podem ser passados na URL da requisição (QueryString), conforme ilustrado na imagem abaixo:

Neste modo os parâmetros são passados com a variável que as recebe, por exemplo CPF (Variável) = 12345678912 (Valor).

Os parâmetros também podem ser realizados via URL da requisição com Route Param, conforme exemplo ilustrado na imagem abaixo:

Neste caso ao passar “APP_TACTIUM”, o servidor que recebe a requisição tratará como o nome da aplicação a ser obtido os templates.

Retorno

O retorno da requisição aparecerá na seção “response”, o Status Code 200 sinaliza que a requisição foi realizada com sucesso, já o “time” indicam em quanto tempo durou a requisição, os valores aparecem logo em seguida, no formato JSON conforme ilustrado abaixo:

A partir do JSON acima, nós conseguimos realizar a manipulação dos dados nos serviços Tactium.