Exibir origem

O que é uma API?
Quais os tipos de erros que uma API pode retornar?
Como testar uma API?
Quais validações devo realizar em uma API?

O que é uma API?

A sigla API refere-se ao termo em inglês "Application Programming Interface" que significa em tradução para o português "Interface de Programação de Aplicativos". Ela é desenvolvida para validar e retornar informações.

Entende-se como em um "livro", ele possui vários capítulos, o mesmo acontece, uma API possui várias "chamadas" podemos comparar a um "check list" são feitas validações como o nome de busca, filtros usados, tipo de arquivo entre outros. Após validado os dados a API retorna mensagens de status acompanhadas com seus códigos (imagem em anexo), como sucesso na operação, erros, problemas sistêmicos etc.

Food Service > Teste de API > 1.png Um Guia Completo sobre HTTP Status Code

Como testar uma API?

As APIs tem diversas formas de serem testadas, neste Share abordaremos:

Teste rápido
Swagger
Postman

Validação rápida da API pelo "console":

Acesse o nosso sistema Degust One (exemplo usado tela de "usuário")
Com a tela aberta pressione: F12 ou Ctrl+Shift+i, será aberto uma nova tela, clicar na aba Network ou rede, após em Fetch/XHR
Ao pressionar o botão "consultar" do sistema é gerado um novo registro (Chamada da API), neste momento é solicitado os os registros de usuários para API e as abas Headers ou Cabeçalhos e Preview ou Visualização apresentam todas as informações necessárias sobre as validações da API e o código de status.

Food Service > Teste de API > image2021-10-19_11-26-25.png

Food Service > Teste de API > image2021-10-19_11-28-8.png

Exemplo de erro:

Food Service > Teste de API > image2021-10-19_13-33-46.png

Food Service > Teste de API > image2021-10-19_14-47-37.png

Swagger (exclusivo Degust One)

Acesse: Swagger UI (lx-degustone-ret-api-hmg.azurewebsites.net). Pesquisar pelo número da chamada que coletamos no "console":

Algumas APIs não apresentam a visualização, para resolver volte ao "console" no final da aba "Headers", no campo "Request Payload" clique em "view parsed",copie e cole o código no Swagger em "Parameters" e apertar o botão "Try it out!" para retornar as informações detalhadas.

(Swagger)

Food Service > Teste de API > image2021-10-20_9-43-9.png

Postman

Para um teste mais detalhado podemos usar vários programas, abordarei sobre o Postman (é um API Cliente que facilita aos desenvolvedores criar, compartilhar, testar e documentar APIs).

Baixe o aplicativo. Após aberto selecionar a opção APIs na lateral pressionar o botão "+" para começar, defina o que se trata sua API se é uma GET, POST, PUT ou DELETE (imagem em anexo).

Food Service > Teste de API > image2021-10-19_11-49-22.png

No sistema colete os dados do "console" como citado a cima na aba Headers colete o dado de Request URL. Ao final coletar o Request payload (clicar em View parsed para aparecer o código) e adicione ao postman e configure como mostra a "imagem 3".

Food Service > Teste de API > image2021-10-19_11-36-25.png

Food Service > Teste de API > image2021-10-19_11-58-33.png

Food Service > Teste de API > image2021-10-19_11-42-46.png

Algumas APIs pode ser necessário passar o authorization token no Postman.

Após configurado o Postman apresenta de forma detalhada a API.

Conteúdo voltado a testes de sistema e qualidade.

Está com alguma dúvida?

Consulte todos nossos guias na busca de nossa página principal clicando aqui.