Skip to content

Commit 49563da

Browse files
andresWeitzelandresWeitzel
authored
Update README.md
1 parent ac8d246 commit 49563da

File tree

1 file changed

+57
-33
lines changed

1 file changed

+57
-33
lines changed

‎README.md‎

Lines changed: 57 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
</br>
2525

26-
### EndPoints y Recursos. Vista Swagger UI
26+
## EndPoints y Recursos. Vista Swagger UI
2727

2828
### EndPoints
2929
* http://localhost:8098/api/v1/productos/
@@ -34,7 +34,7 @@
3434

3535
</br>
3636

37-
### Documentación Gráfica de algunos Recursos la Api.
37+
## Documentación Gráfica de algunos Recursos la Api.
3838

3939
</br>
4040

@@ -46,49 +46,46 @@
4646

4747
### Recursos por Endpoint
4848

49-
#### Documentación con Swagger-UI `auth-controller`
49+
### Documentación con Swagger-UI `auth-controller`
5050
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/controllers/authController.png)
5151

52-
#### Documentación con Swagger-UI `producto-controller`
52+
### Documentación con Swagger-UI `producto-controller`
5353
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/controllers/productosController.png)
5454

55-
#### Documentación con Swagger-UI `usuario-controller`
55+
### Documentación con Swagger-UI `usuario-controller`
5656
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/controllers/usuarioController.png)
5757

58-
59-
#### Listado de Productos Paginados
58+
### Listado de Productos Paginados
6059
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getAll.png)
6160
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getAllResponse.png)
6261

6362

64-
#### Listado de Productos o Producto Paginado/s por Fecha
65-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getByFecha.png" />
66-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getByFechaResponse.png" />
67-
68-
#### Inserción de un Producto Método Post
69-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/post.png" />
70-
71-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/postResponse.png" />
63+
### Listado de Productos o Producto Paginado/s por Fecha
64+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getByFecha.png)
65+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/get/getByFechaResponse.png)
7266

73-
#### Búsqueda del Producto Insertado según su Código
74-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/getByCodigo.png" />
75-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/getByCodigoResponse.png" />
7667

77-
#### Actualización de un Producto Método Put
78-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/put/put.png" />
79-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/put/putResponse.png" />
80-
81-
#### Eliminación de un Producto Método Delete
82-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/delete.png" />
83-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/deleteResponse.png" />
84-
68+
### Inserción de un Producto Método Post
69+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/post.png)
70+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/postResponse.png)
71+
72+
### Búsqueda del Producto Insertado según su Código
73+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/getByCodigo.png)
74+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/post/getByCodigoResponse.png)
8575

76+
### Actualización de un Producto Método Put
77+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/put/put.png)
78+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/put/putResponse.png)
8679

87-
#### Búsqueda del Producto Eliminado según su Id
88-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/getById.png" />
89-
<img width="70%" height="50%" src="https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/getByIdResponse.png" />
9080

81+
### Eliminación de un Producto Método Delete
82+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/delete.png)
83+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/deleteResponse.png)
9184

85+
### Búsqueda del Producto Eliminado según su Id
86+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/getById.png)
87+
![Index app](https://github.com/andresWeitzel/ApiRest_ElectroThingsV1_SpringBoot_MongoDB/blob/master/documentation/delete/getByIdResponse.png)
88+
9289

9390

9491
</br>
@@ -101,6 +98,9 @@
10198
| Spring Tool Suite 4 | 4.9.0 | IDE |
10299
| Spring Boot | 2.6.4 | Framework |
103100
| Spring Boot Data JPA | 2.6.3 | Mapeo de objetos y persistencia en la db |
101+
| Spring Validation | 2.7 | Anotations para Validaciones |
102+
| Spring Security | 2.6.7 | Módulo de Seguridad de Spring |
103+
| Json Web Token | 0.9.1 | Manejo de Token's de Seguridad |
104104
| Lombok | 1.18.22 | Automatización de Código |
105105
| Open-Api y UI Swagger | 1.6.4 | Documentación de la Api |
106106
| UI Swagger | 1.6.4 | Visualización y Gestión de la Api |
@@ -135,6 +135,10 @@
135135
| ------------- | ------------- |
136136
| DAO | Uso de interfaces entre la aplicación y el almacenamiento de datos. |
137137
| MVC | Separación y Representación de los Datos, Manejo de errores, Escalabilidad, etc |
138+
| DTO | Transferencia de objectos separando la capa de acceso a datos |
139+
| Dependency Inyection | Uso de funcionalidades requeridas de clases a través de inyección |
140+
| Otros | Otros |
141+
138142

139143
</br>
140144

@@ -144,8 +148,17 @@
144148
| ------------- | ------------- | ------------- |
145149
| spring-boot-starter-data-jpa | 2.6.7 | Api de JpaRepository para el manejo de métodos |
146150
| spring-boot-starter-test | 2.6.7 | Para Testing |
147-
| spring-boot-starter-web | 2.6.7 | Se agrega toda la configuración web automáticamente de Maven a Spring |
148-
| spring-boot-starter-validation | 2.6.7 | Uso de Validacion desde nuestro Bean |
151+
| spring-boot-starter-web | 2.6.7 | Se agrega toda la configuración web automáticamente de Maven a Spring |
152+
| spring-boot-starter-validation | 2.7.0 | Validación de Annotations |
153+
| spring-boot-devtools | 2.6.7 | Herramientas para el Manejo de Spring Boot |
154+
| spring-boot-starter-security | 2.6.7 | Módulo de Seguridad de Spring |
155+
| jjwt | 0.9.1 | Manejo de Token's |
156+
| nimbus-jose-jwt | 9.22 | Refresh Token |
157+
| jaxb-api | 4.0 | Serialización de Objetos Java a XML |
158+
| jackson-databind | 4.0 | Serialización de Objetos Java a JSON |
159+
| javax-annotation-api | 4.0 | Api para la lectura de annotations|
160+
| springfox-boot-starter | 3.0.0 | Doc Api |
161+
| springfox-swagger-ui | 3.0.0 | Doc Api |
149162
| spring-boot-starter-data-mongodb | 2.6.7 | Manejo de SpringDataMongoDB con los métodos del Repository y anotations |
150163
| springdoc-openapi-ui | 1.6.4 | Plantillas para el Front |
151164
| spring-boot-devtools | 2.6.7 | Herramientas para el Manejo de Spring Boot |
@@ -156,7 +169,7 @@
156169

157170
</br>
158171

159-
### Documentación No Oficial Recomendada
172+
### Doc No Oficial Recomendada
160173
#### Api Rest con MongoDB/SpringBoot
161174
* Api Rest Spring Boot Mongodb : https://www.youtube.com/watch?v=OtBukxJy4kg
162175
* Api Rest Guía Spring Boot Mongodb Codigo :https://github.com/heroe-geek/rest-api-springboot-mvc/blob/master/src/main/java/com/hg/crud/controllers/ProductController.java
@@ -169,9 +182,20 @@
169182
* Tutorial Uso de Querys en MongoDB : https://www.baeldung.com/queries-in-spring-data-mongodb
170183
* Tutorial Querys MongoRepository : https://stackabuse.com/spring-data-mongodb-guide-to-the-query-annotation/
171184
* Código Ejemplo genérico : https://github.com/heroe-geek/rest-api-springboot-mvc/blob/master/src/main/java/com/hg/crud/models/ProductDTO.java
185+
#### Swagger UI y SpringFox
186+
* Config Swagger: https://www.baeldung.com/swagger-set-example-description
187+
* Generar doc con swagger : https://howtodoinjava.com/swagger2/swagger-spring-mvc-rest-example/
188+
* Api Response con swagger : https://docs.swagger.io/swagger-core/v1.5.0/apidocs/io/swagger/annotations/ApiResponse.html
189+
* Códigos HTTP de respuestas desarrollar en apis :https://www.ibm.com/docs/es/odm/8.5.1?topic=api-rest-response-codes-error-messages
190+
191+
### Doc Gráfica No Oficial Recomendada
192+
* Implementación de Spring Security y JWT Youtube : https://www.youtube.com/watch?v=_91iKzsKdqY&list=PL4bT56Uw3S4z9rtwwGvuk1Mjhu5sdLSwX&index=12
193+
* Implementación Spring Security : https://www.youtube.com/watch?v=tDZPdovCH4I
194+
* Tutorial doc open-api : https://www.youtube.com/watch?v=iaVBleTf88U
195+
172196

173197

174198
</br>
175199

176-
## Documentación de Desarrollo del Repositorio No Disponible Momentáneamente
200+
## Documentación de Desarrollo de la Api No Disponible Momentáneamente
177201

0 commit comments

Comments
 (0)