Merge pull request #66 from rcsim/feature/swagger

Feature/swagger
rcsim · Sep 3, 2023 · 7eda16e · 7eda16e
2 parents fcbe964 + 9985201
commit 7eda16e
Show file tree

Hide file tree

Showing 20 changed files with 19 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -37,93 +37,57 @@ A principal dificultade encontrada foi a necessidade de se realizar algumas refa
 
 URL: http://localhost:8080/dependent
 
-Pessoas relacionadas ao nosso cliente, com algum nível de parentesco.
 
-- Json da classe de Dependentes para o Postman com todos os campos preenchidos. 
-```json
-{
-    "name":"Victor",
-    "dateOfBirth":"28/12/1998",
-    "gender":"Masculino",
-    "parentage":"Teste"
-}
-```
-- Resposta da requisição
-![image](https://github.com/rcsim/tech-challenge/assets/71778151/4da03697-9013-4135-a471-758a1a057947)
 
-- Dados inseridos no banco
-<img src = "image/createdDependent_BD.png" />
+<img src = "./image/deleteDependentID.png" />
 
+<img src = "./image/getDependent.png" />
 
-- Json da classe de Dependentes para o Postman com todos os campos nulos. 
+<img src = "./image/getDependentId.png" />
 
-![image](https://github.com/rcsim/tech-challenge/assets/71778151/895ef567-ca60-4cdf-b496-415dcae26a58)
+<img src = "./image/getDependentIDAppliances.png" />
 
-- Json da classe de Dependentes para o Postman com todos os campos vazios. 
-
-![image](https://github.com/rcsim/tech-challenge/assets/71778151/6fb2c201-9f1f-41d2-8d81-4f59f736c294)
+<img src = "./image/postDependent.png" />
 
+<img src = "./image/putDependentID.png" />
 
 
 #### ---- ENDEREÇOS ----
 
 URL: http://localhost:8080/address
 
-- Json da classe de Endereços para o Postman com todos os campos preenchidos.
-
-```json
-{
-  "street":"Avenida Augusto de Lima",
-  "number":"486",
-  "district":"Centro",
-  "city":"Belo Horizonte",
-  "estate":"Minas Gerais"
-}
+<img src = "./image/deleteAddressId.png" />
 
-```
-- Resposta da requisição
-<img src = "image/createdAddressPostman_status201.png" />
+<img src = "./image/getAddress.png" />
 
-- Dados inseridos no banco
-<img src = "image/createdAddress_BD.png" />
+<img src = "./image/getAddressId.png" />
 
+<img src = "./image/getAddressIdAppliances.png" />
 
-- Json da classe de Endereços para o Postman com todos os campos nulos.
-<img src = "image/addressError_Nulo.png" />
+<img src = "./image/getAddressIdDependent.png" />
 
-- Json da classe de Endereços para o Postman com todos os campos vazios.
-<img src = "image/addressError_Vazio.png" />
+<img src = "./image/postAddress.png" />
 
+<img src = "./image/putAddressId.png" />
 
 
 #### ---- ELETRODOMÉSTICOS ----
 
 URL: http://localhost:8080/appliance
 
-- Json da classe de Eletrodomésticos para o Postman com todos os campos preenchidos. 
 
-```json
-{
-  "name":"HP",
-  "model":"G42",
-  "power":"90w",
-  "manufacturer":"Hewlett-Packard"
-}
+<img src = "./image/deleteApplianceID.png" />
 
-```
-- Resposta da requisição
-<img src = "image/createdApplience_Postman_status201.png" />
+<img src = "./image/getAppliance.png" />
 
-- Dados inseridos no banco
-<img src = "image/createdApplience_BD.png" />
+<img src = "./image/getApplianceID.png" />
 
+<img src = "./image/getApplianceDepedent.png" />
 
-- Json da classe de Eletrodomésticos para o Postman com todos os campos nulos.
-<img src = "image/applienceError_Nulo.png" />
+<img src = "./image/postAppliance.png" />
 
+<img src = "./image/putApplianceID.png" />
 
-- Json da classe de Eletrodomésticos para o Postman com todos os campos vazios.
-<img src = "image/applienceError_Vazio.png" />
 
 
 

diff --git a/image/deleteAddressId.png b/image/deleteAddressId.png
diff --git a/image/deleteApplianceID.png b/image/deleteApplianceID.png
diff --git a/image/deleteDependentID.png b/image/deleteDependentID.png
diff --git a/image/getAddress.png b/image/getAddress.png
diff --git a/image/getAddressId.png b/image/getAddressId.png
diff --git a/image/getAddressIdAppliances.png b/image/getAddressIdAppliances.png
diff --git a/image/getAddressIdDependent.png b/image/getAddressIdDependent.png
diff --git a/image/getAppliance.png b/image/getAppliance.png
diff --git a/image/getApplianceDepedent.png b/image/getApplianceDepedent.png
diff --git a/image/getApplianceID.png b/image/getApplianceID.png
diff --git a/image/getDependent.png b/image/getDependent.png
diff --git a/image/getDependentIDAppliances.png b/image/getDependentIDAppliances.png
diff --git a/image/getDependentId.png b/image/getDependentId.png
diff --git a/image/postAddress.png b/image/postAddress.png
diff --git a/image/postAppliance.png b/image/postAppliance.png
diff --git a/image/postDependent.png b/image/postDependent.png
diff --git a/image/putAddressId.png b/image/putAddressId.png
diff --git a/image/putApplianceID.png b/image/putApplianceID.png
diff --git a/image/putDependentID.png b/image/putDependentID.png