Resumo Da API

Prévia do material em texto

1) Criamos uma Models crie uma classe para modelar um objeto de 
domínio da aplicação 
2) Criáramos classe que servirá de repositório de dados simulados, 
contendo apenas alguns dados estáticos que retornaremos e alteraremos 
a partir dos métodos da API 
3) Criaremos um controller do tipo ApiController esse controller 
basicamente possui actions para os principais verbos do protocolo 
HTTP: GET, POST, PUT e DELETE. Onde usaremos o programa Postman para 
demostrar o funcionamento 
4) Este controller basicamente lista todos os alunos ou apenas um pelo 
id através do método GET, adiciona um aluno via POST, altera um aluno 
via PUT e exclui um aluno via DELETE. 
5) Testando a API 
6) Postman adicione o endereço 
7) /api/alunos - 
8) Aperdando o Send - Enviando GET pelo Postman 
9) Resultado do GET no Postman Today = No lado esquerdo vemos o 
histórico de requisições realizadas. Caso seja necessário, é possível 
clicar sobre uma delas e repeti-la; 
Tela principal = Na parte inferior temos o resultado da requisição, 
que neste caso é a lista de alunos cadastrados. Logo acima do 
resultado é possível mudar a forma de visualização, alterando o 
formato; 
Tempo da requisição =Podemos ver também o status da operação (que 
neste caso foi 200 – OK) e o tempo que demorou para se obter o 
resultado (22ms neste exemplo). 
 
10) método a ser testado é o GET, em que passamos o ID de um aluno no 
URL = Resultado do GET filtrando por ID 
 
11)Resultado do GET filtrando por ID = Caso informemos um ID que não 
existe na lista (neste exemplo, qualquer número diferente de 1 á 10), 
teremos como resultado a mensagem que foi retornada pelo serviço e o 
status de retorno será 404 – Not Found 
Retorno com status 404 – Not Found 
 
12) Configurando a mensagem via POST = Testaremos agora a action que 
responde a requisições utilizando o verbo POST 
A URL para o qual enviaremos a requisição será a mesma em que fizemos 
o primeiro GET (<host>/api/alunos), basta alterarmos o verbo para POST 
no lado esquerdo do campo em que inserimos o endereço. 
Em seguida devemos ir à aba “Body” e marcar a opção “raw”, uma vez que 
informaremos o conteúdo da mensagem na forma de texto já formatado 
como JSON. Logo em seguida devemos selecionar o formato “JSON 
(application/json)” 
Após inserir os dados do aluno a ser enviado (em formato JSON), 
devemos clicar novamente em “Send” e observar o resultado, que se tudo 
correu bem, deve ser um status 200 – Ok 
13)Requisição via POST com retorno 409 – Conflict = Se tentarmos 
inserir um aluno com ID que já esteja cadastrado receberemos como 
resultado um status 409 – Conflict e uma mensagem informando o 
problema, 
14) Se fizermos agora um novo request GET teremos na lista o novo 
aluno adicionado 
 
15)Mensagem enviada via PUT = O método Put do controller basta alterar 
o verbo do request para PUT (mantendo o endereço base) e, de forma 
semelhante ao POST, informe o conteúdo do objeto aluno a ser alterado 
no campo central. Se tudo correr bem, teremos como resultado um status 
200 – Ok (Figura 15), caso contrário, se informarmos um ID 
inexistente, teremos um 404 – Not Found. 
 
16) Requisição com verbo DELETE = testar o método DELETE, além de 
mudar o verbo ao lado do endereço, devemos adicionar ao fim da URL o 
ID do aluno a ser excluído, semelhante ao que fizemos no segundo GET 
Além das funcionalidades que exploramos aqui, o Postman permite ainda 
trabalhar em times, customizar ambientes de teste, importar arquivos 
com requisições pré-definidas, entre outras. 
Quando se está desenvolvendo um serviço que será exposto para clientes 
externos, é fundamental que os mais diversos testes sejam realizados a 
fim de validar o funcionamento da aplicação diante das diversas 
situações possíveis. Com o Postman essa tarefa é simplificada, pois 
podemos facilmente enviar requests HTTP para serviços RESTful, 
enviando parâmetros e recebendo as devidas respostas, além de analisar 
o tempo gasto em cada requisição, o que também pode auxiliar na 
localização de problemas de desempenho. 
 
A ferramenta possui ampla documentação, que pode ser encontrada no 
link no final do artigo, além de uma versão paga que conta com alguns 
recursos adicionais, como o trabalho em nuvem.