Skip to content

GitLab

postman_utilizacao · Changes

Page history
#19 Atualização imagens authored by Gabriel Fanto Stundner's avatar Gabriel Fanto Stundner
Hide whitespace changes
Inline Side-by-side
backend/postman_utilizacao.md
View page @ c9dc8e48
...@@ -31,15 +31,15 @@ ...@@ -31,15 +31,15 @@
1) no topo a esquerda do postman tem a opção **import**, clique nele e ele abre uma página para fazer upload dos arquivos 1) no topo a esquerda do postman tem a opção **import**, clique nele e ele abre uma página para fazer upload dos arquivos
<img src="resources\images\postman\1_import.png"> <img src="resources/images/postman/1_import.png">
2) Importe a **coleção**(conjunto de requisições) e o **ambiente**(onde ficam as variáveis necessárias para as requisições) desejada do diretório **Requisições** 2) Importe a **coleção**(conjunto de requisições) e o **ambiente**(onde ficam as variáveis necessárias para as requisições) desejada do diretório **Requisições**
<img src="resources\images\postman\2_select_all.png"> <img src="resources/images/postman/2_select_all.png">
3) No postman vai mostrar quais você está importanto e informações importantes 3) No postman vai mostrar quais você está importanto e informações importantes
<img src="resources\images\postman\3_import_selected.png"> <img src="resources/images/postman/3_import_selected.png">
4) Dentro de toda coleção de requisições tem dois diretórios: 4) Dentro de toda coleção de requisições tem dois diretórios:
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
4.2) **VALIDATIONS** ficam as validações dos objetos dentro da entidade. 4.2) **VALIDATIONS** ficam as validações dos objetos dentro da entidade.
<img src="resources\images\postman\4_folder_organization.png"> <img src="resources/images/postman/4_folder_organization.png">
5) As requisições devem possuir as seguintes nomenclaturas: 5) As requisições devem possuir as seguintes nomenclaturas:
...@@ -56,21 +56,21 @@ ...@@ -56,21 +56,21 @@
``` ```
Deve seguir o padrão CRUD Deve seguir o padrão CRUD
<img src="resources\images\postman\CRUD.png"> <img src="resources/images/postman/CRUD.png">
<img src="resources\images\postman\5_requisitions.png"> <img src="resources/images/postman/5_requisitions.png">
6) As validações o nome deve ser o que está sendo validado, onde deve possuir uma requisição para casa validação e objeto: 6) As validações o nome deve ser o que está sendo validado, onde deve possuir uma requisição para casa validação e objeto:
<img src="resources\images\postman\6_validations.png"> <img src="resources/images/postman/6_validations.png">
7) O **Ambiente** (Enviroment) ficam as constantes utilizadas no projeto, onde cada conjunto de requisição terá o seu, mesmo que tenham somente a URL de teste 7) O **Ambiente** (Enviroment) ficam as constantes utilizadas no projeto, onde cada conjunto de requisição terá o seu, mesmo que tenham somente a URL de teste
* Sua localização fica a direita bem na ponta * Sua localização fica a direita bem na ponta
<img src="resources\images\postman\7_enviroment.png"> <img src="resources/images/postman/7_enviroment.png">
<img src="resources\images\postman\8_understand_enviroment.png"> <img src="resources/images/postman/8_understand_enviroment.png">
* Quando é testado, na hora que é criado um objeto da entidade, ele vai salvar o ID do objeto criado no banco e esse valor vai ser salvo no ambiente **Global** (globals), onde ficam as variáveis de utilização entre requisições * Quando é testado, na hora que é criado um objeto da entidade, ele vai salvar o ID do objeto criado no banco e esse valor vai ser salvo no ambiente **Global** (globals), onde ficam as variáveis de utilização entre requisições
...@@ -99,11 +99,11 @@ Deve seguir o padrão CRUD ...@@ -99,11 +99,11 @@ Deve seguir o padrão CRUD
1) Na aba **Body** no postman iremos colocar os dados que queremos salvar, dai quando cliado no botão **Send** ele vai enviar os dados para a API e terá como retorno o Status que retornou da API e um JSON no **Response** com os dados salvos 1) Na aba **Body** no postman iremos colocar os dados que queremos salvar, dai quando cliado no botão **Send** ele vai enviar os dados para a API e terá como retorno o Status que retornou da API e um JSON no **Response** com os dados salvos
<img src="resources\images\postman\9_POST1.png"> <img src="resources/images/postman/9_POST1.png">
2) Na aba **Tests** os testes são criados em Javascript e devem ser colocados em ordem, assim que o resultado da requisição for 201 ele vai salvar o ID do objeto em uma variável global 2) Na aba **Tests** os testes são criados em Javascript e devem ser colocados em ordem, assim que o resultado da requisição for 201 ele vai salvar o ID do objeto em uma variável global
<img src="resources\images\postman\9_POST2.png"> <img src="resources/images/postman/9_POST2.png">
#### GET By ID #### GET By ID
...@@ -114,11 +114,11 @@ Deve seguir o padrão CRUD ...@@ -114,11 +114,11 @@ Deve seguir o padrão CRUD
1) Na **URL** da requisição chamamos a variável global que foi gerada com a requisição **POST** ou podemos criar a variável manualmente no **Enviroment**, mas somente se o conjunto de requisições não tem como conseguir esse id. 1) Na **URL** da requisição chamamos a variável global que foi gerada com a requisição **POST** ou podemos criar a variável manualmente no **Enviroment**, mas somente se o conjunto de requisições não tem como conseguir esse id.
<img src="resources\images\postman\10_GETID1.png"> <img src="resources/images/postman/10_GETID1.png">
2) Na aba **Tests** somente tem o teste que o GET deve retornar o código 200, mas podemos ter testes que também salvam um ID específico caso precise. O retorno da requisição é o objeto que demos o ID que está salvo no banco de dados 2) Na aba **Tests** somente tem o teste que o GET deve retornar o código 200, mas podemos ter testes que também salvam um ID específico caso precise. O retorno da requisição é o objeto que demos o ID que está salvo no banco de dados
<img src="resources\images\postman\10_GETID2.png"> <img src="resources/images/postman/10_GETID2.png">
#### PUT #### PUT
...@@ -130,15 +130,15 @@ Deve seguir o padrão CRUD ...@@ -130,15 +130,15 @@ Deve seguir o padrão CRUD
1) Na **URL** da requisição chamamos a variável global que foi gerada com a requisição **POST** ou podemos criar a variável manualmente no **Enviroment**, mas somente se o conjunto de requisições não tem como conseguir esse id. 1) Na **URL** da requisição chamamos a variável global que foi gerada com a requisição **POST** ou podemos criar a variável manualmente no **Enviroment**, mas somente se o conjunto de requisições não tem como conseguir esse id.
2) No **Body** da requisição colocamos quais dados queremos editar do objeto salvo no banco, eles devem ter os mesmos nomes dos objetos salvos, senão vai dar um erro 2) No **Body** da requisição colocamos quais dados queremos editar do objeto salvo no banco, eles devem ter os mesmos nomes dos objetos salvos, senão vai dar um erro
<img src="resources\images\postman\11_PUT1.png"> <img src="resources/images/postman/11_PUT1.png">
3) No **Response** (resposta da API) vai mostar um JSON com os dados do objeto que foram salvos no banco, já mostrando a atualização dos dados que você pediu para alterar e os dados das outras variáveis como estão salvar no banco. 3) No **Response** (resposta da API) vai mostar um JSON com os dados do objeto que foram salvos no banco, já mostrando a atualização dos dados que você pediu para alterar e os dados das outras variáveis como estão salvar no banco.
<img src="resources\images\postman\11_PUT2.png"> <img src="resources/images/postman/11_PUT2.png">
4) Na aba **Tests** é feito um tipo diferente de teste, onde além de verificar se o ID é um número ele vai verificar se o ID da resposta é o mesmo ID da variável global criada pelo **POST**, por isso essa variável global não pode ser alterada manualmente, somente pela requisição **POST**. 4) Na aba **Tests** é feito um tipo diferente de teste, onde além de verificar se o ID é um número ele vai verificar se o ID da resposta é o mesmo ID da variável global criada pelo **POST**, por isso essa variável global não pode ser alterada manualmente, somente pela requisição **POST**.
<img src="resources\images\postman\11_PUT3.png"> <img src="resources/images/postman/11_PUT3.png">
#### GET ALL #### GET ALL
...@@ -149,7 +149,7 @@ Deve seguir o padrão CRUD ...@@ -149,7 +149,7 @@ Deve seguir o padrão CRUD
1) Deve apresentar no **Response** todos os objetos que estão salvos no banco **do objeto passado na url**. 1) Deve apresentar no **Response** todos os objetos que estão salvos no banco **do objeto passado na url**.
<img src="resources\images\postman\12_GETALL.png"> <img src="resources/images/postman/12_GETALL.png">
#### DELETE #### DELETE
...@@ -162,7 +162,7 @@ Deve seguir o padrão CRUD ...@@ -162,7 +162,7 @@ Deve seguir o padrão CRUD
2) Nos testes é verificado se o ID da exclusão é o mesmo que o ID salvo na variável global criada pelo **POST**, por isso essa variável global não pode ser alterada manualmente, somente pela requisição **POST**. 2) Nos testes é verificado se o ID da exclusão é o mesmo que o ID salvo na variável global criada pelo **POST**, por isso essa variável global não pode ser alterada manualmente, somente pela requisição **POST**.
3) Após deletado e apresentado o ID e verificado, é limpo todas as variáveis globais. 3) Após deletado e apresentado o ID e verificado, é limpo todas as variáveis globais.
<img src="resources\images\postman\13_DELETE.png"> <img src="resources/images/postman/13_DELETE.png">
#### VALIDATIONS #### VALIDATIONS
...@@ -172,19 +172,19 @@ Deve seguir o padrão CRUD ...@@ -172,19 +172,19 @@ Deve seguir o padrão CRUD
1) Para cada variável ou objeto, deve ter um diretório interno com suas requisições de validação 1) Para cada variável ou objeto, deve ter um diretório interno com suas requisições de validação
<img src="resources\images\postman\14_validations1.png"> <img src="resources/images/postman/14_validations1.png">
2) Essas requisições devem dar as mensagens de erros definidos nas validações do DTO 2) Essas requisições devem dar as mensagens de erros definidos nas validações do DTO
<img src="resources\images\postman\14_validations2.png"> <img src="resources/images/postman/14_validations2.png">
3) Todas as requisições vão dar o tipo de resultado **400 Bad Request** e no **Response** vai ser apresentado a mensagem definida para o tipo de erro 3) Todas as requisições vão dar o tipo de resultado **400 Bad Request** e no **Response** vai ser apresentado a mensagem definida para o tipo de erro
<img src="resources\images\postman\14_validations3.png"> <img src="resources/images/postman/14_validations3.png">
4) Nos testes é somente verificado se realmente foi o status 400 que ocorreu 4) Nos testes é somente verificado se realmente foi o status 400 que ocorreu
<img src="resources\images\postman\14_validations4.png"> <img src="resources/images/postman/14_validations4.png">
#### Rodando todos os testes ao mesmo tempo #### Rodando todos os testes ao mesmo tempo
...@@ -192,15 +192,15 @@ Deve seguir o padrão CRUD ...@@ -192,15 +192,15 @@ Deve seguir o padrão CRUD
* Isso ajuda a não ter que rodar uma a uma para testar se tudo está certo. * Isso ajuda a não ter que rodar uma a uma para testar se tudo está certo.
* Todas as requisições devem estar na seguinte ordem: * Todas as requisições devem estar na seguinte ordem:
<img src="resources\images\postman\15_runner1.png"> <img src="resources/images/postman/15_runner1.png">
* Após estar na ordem correta e seguindo o padrão apresentado em cada uma das requisições do CRUD, iremos selecionar a pasta do CRUD e vai mostrar a seguinte página: * Após estar na ordem correta e seguindo o padrão apresentado em cada uma das requisições do CRUD, iremos selecionar a pasta do CRUD e vai mostrar a seguinte página:
<img src="resources\images\postman\15_runner2.png"> <img src="resources/images/postman/15_runner2.png">
* Ao clicar no botão **Run** na parte de cima dessa página, irá trazer todas as requisições criadas na ordem que estão no diretório, onde o postman irá verificar elas em ordem os testes definidos na aba **Tests** * Ao clicar no botão **Run** na parte de cima dessa página, irá trazer todas as requisições criadas na ordem que estão no diretório, onde o postman irá verificar elas em ordem os testes definidos na aba **Tests**
<img src="resources\images\postman\15_runner3.png"> <img src="resources/images/postman/15_runner3.png">
* São os testes das requisições que importam, onde todos verificam o status que deve retornar da requisição, alguns irão verificar o ID salvo com a variável global(PUT e DELETE) e alguns irão salvar o ID na variável global (POST), por isso que é importante eles estarem em ordem, porque eles vão fazer o seguinte: * São os testes das requisições que importam, onde todos verificam o status que deve retornar da requisição, alguns irão verificar o ID salvo com a variável global(PUT e DELETE) e alguns irão salvar o ID na variável global (POST), por isso que é importante eles estarem em ordem, porque eles vão fazer o seguinte:
* O POST vai criar o objeto, salvar no banco e pegar o ID e salvar na variável global. * O POST vai criar o objeto, salvar no banco e pegar o ID e salvar na variável global.
...@@ -212,7 +212,7 @@ Deve seguir o padrão CRUD ...@@ -212,7 +212,7 @@ Deve seguir o padrão CRUD
* Ele vai mostrar em verde e com a mensagem **Pass** se a requisição passou no teste definido na aba **Tests** * Ele vai mostrar em verde e com a mensagem **Pass** se a requisição passou no teste definido na aba **Tests**
* Para os testes serem validados pelo revisor, **TODAS AS REQUISIÇÕES DEVEM ESTAR PASSANDO NOS TESTES**. * Para os testes serem validados pelo revisor, **TODAS AS REQUISIÇÕES DEVEM ESTAR PASSANDO NOS TESTES**.
<img src="resources\images\postman\15_runner4.png"> <img src="resources/images/postman/15_runner4.png">
* é muito importante o revisor verificar se passou todos os testes e se no banco foi realmente alterado os valores, por isso o revisor deve testar um a um vendo se estão fazendo o que devia e depois testar todos ao mesmo tempo usando o runner do postman. * é muito importante o revisor verificar se passou todos os testes e se no banco foi realmente alterado os valores, por isso o revisor deve testar um a um vendo se estão fazendo o que devia e depois testar todos ao mesmo tempo usando o runner do postman.
......