Skip to content

Commit 2328e78

Browse files
dbacilio88dbacilio88
committed
feat(readme): documentation
documentation exception handler exception readme changelog
1 parent 032b42f commit 2328e78

File tree

5 files changed

+216
-18
lines changed

5 files changed

+216
-18
lines changed

‎CHANGELOG.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Documentación de Cambios archetype spring - java
2+
3+
## [spring-boot-3-jdk-21]
4+
### Agregado 2024-10-28
5+
- Implementación de estructura del proyecto `components`
6+
- Implementación de estructura del proyecto `components/interfaces`
7+
- Implementación de estructura del proyecto `components/configuration`
8+
- Implementación de estructura del proyecto `components/enums`
9+
- Implementación de estructura del proyecto `components/exceptions`
10+
- Implementación de estructura del proyecto `components/exceptions/handler`
11+
- Implementación de estructura del proyecto `components/mappers`
12+
- Implementación de estructura del proyecto `components/utils`
13+
- Implementación de estructura del proyecto `controllers`
14+
- Implementación de estructura del proyecto `controllers/contracts`
15+
- Implementación de estructura del proyecto `controllers/implementations`
16+
- Implementación de estructura del proyecto `dtos`
17+
- Implementación de estructura del proyecto `repositories`
18+
- Implementación de estructura del proyecto `repositories/entities`
19+
- Implementación de estructura del proyecto `services`
20+
- Implementación de estructura del proyecto `services/contracts`
21+
- Implementación de estructura del proyecto `services/implementations`
22+
- Implementación de estructura del proyecto `resources`
23+
- Implementación de estructura del proyecto `resources/application.yml`
24+
- Implementación de estructura del proyecto `resources/application-dev.yml`
25+
- Implementación de CRUD para la entidad `Application` ejemplo básico.
26+
- Implementación de excepciones global para capturar y manejar excepciones personalizadas.
27+
- Gestion de dependencias con **Maven** y **Gradle**
28+
29+
30+
### Cambiado
31+
- No cambios.
32+
33+
### Corregido
34+
- No correcciones
35+
36+
---

‎README.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
11
# 🎯 archetype-api-microservices
22

33
<!-- TOC -->
4-
54
* [🎯 archetype-api-microservices](#-archetype-api-microservices)
65
* [🧩 Descripción general](#-descripción-general)
76
* [🔖 Características](#-características)
8-
* [📋 Requisitos](#-requisitos)
7+
* [📋 Requisitos](#-requisitos)
98
* [🪛 Crear un proyecto](#-crear-un-proyecto)
10-
* [📀 Instalación](#-instalación)
11-
* [💻 Construir en Terminal bash](#-construir-en-terminal-bash)
12-
* [🖥️ Construir en Terminal cmd](#-construir-en-terminal-cmd)
13-
* [🧮 Estructura del proyecto](#-estructura-del-proyecto)
14-
* [🔧 Tecnologías Usadas](#-tecnologías-usadas)
15-
* [⚙️ Configuración rápida](#-configuración-rápida)
16-
* [🧰 Integración de dependencias](#-integración-de-dependencias)
17-
* [📦 Ejemplo de código](#-ejemplo-de-código)
9+
* [📀 Instalación](#-instalación)
10+
* [💻 Construir en Terminal bash](#-construir-en-terminal-bash)
11+
* [🖥️ Construir en Terminal cmd](#-construir-en-terminal-cmd)
12+
* [🧮 Estructura del proyecto](#-estructura-del-proyecto)
13+
* [🔧 Tecnologías Usadas](#-tecnologías-usadas)
14+
* [⚙️ Configuración rápida](#-configuración-rápida)
15+
* [🧰 Integración de dependencias](#-integración-de-dependencias)
16+
* [📦 Ejemplo de código](#-ejemplo-de-código)
1817
* [🧪 Uso](#-uso)
1918
* [👨🏻‍💻 Contribuciones](#-contribuciones)
2019
* [📞 Contacto](#-contacto)
21-
2220
<!-- TOC -->
2321

2422
# 🧩 Descripción general
@@ -89,10 +87,12 @@ mvn archetype:generate ^
8987
## 🧮 Estructura del proyecto
9088

9189
```
92-
Disk:.
90+
Disk:
9391
├───deploy
9492
├───docs
9593
│ └───collections
94+
├───gradle
95+
│ └───wrapper
9696
└───src
9797
├───main
9898
│ ├───java
@@ -102,7 +102,9 @@ Disk:.
102102
│ │ └───application
103103
│ │ ├───components
104104
│ │ │ ├───configuration
105+
│ │ │ ├───enums
105106
│ │ │ ├───exceptions
107+
│ │ │ │ └───handler
106108
│ │ │ ├───interfaces
107109
│ │ │ ├───mappers
108110
│ │ │ └───utils

‎src/main/resources/archetype-resources/pom.xml‎

Lines changed: 161 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,168 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns="http://maven.apache.org/POM/4.0.0">
32

43
<modelVersion>4.0.0</modelVersion>
54

5+
<parent>
6+
<groupId>org.springframework.boot</groupId>
7+
<artifactId>spring-boot-starter-parent</artifactId>
8+
<version>3.3.4</version>
9+
<relativePath/>
10+
</parent>
11+
612
<groupId>${groupId}</groupId>
713
<artifactId>${artifactId}</artifactId>
814
<version>${version}</version>
9-
<description>${description}</description>
15+
<description>${artifactId}</description>
16+
17+
18+
<developers>
19+
<developer>
20+
<id>bxcode</id>
21+
<name>cbaciliod</name>
22+
<email>dbacilio88@gmail.com</email>
23+
<organization>bacsystem</organization>
24+
<roles>
25+
<role>developer</role>
26+
</roles>
27+
</developer>
28+
</developers>
29+
<properties>
30+
<java.version>21</java.version>
31+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
32+
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
33+
</properties>
34+
35+
<dependencies>
36+
<!--dependencies app build-->
37+
<dependency>
38+
<groupId>org.springframework.boot</groupId>
39+
<artifactId>spring-boot-starter-web</artifactId>
40+
<exclusions>
41+
<exclusion>
42+
<groupId>org.springframework.boot</groupId>
43+
<artifactId>spring-boot-starter-logging</artifactId>
44+
</exclusion>
45+
</exclusions>
46+
</dependency>
47+
48+
<dependency>
49+
<groupId>org.springframework.boot</groupId>
50+
<artifactId>spring-boot-starter-actuator</artifactId>
51+
</dependency>
52+
53+
<dependency>
54+
<groupId>org.springframework.boot</groupId>
55+
<artifactId>spring-boot-starter-validation</artifactId>
56+
</dependency>
57+
58+
<dependency>
59+
<groupId>org.springframework.boot</groupId>
60+
<artifactId>spring-boot-starter-data-jpa</artifactId>
61+
</dependency>
62+
63+
<!--dependencies app logging-->
64+
65+
<dependency>
66+
<groupId>org.springframework.boot</groupId>
67+
<artifactId>spring-boot-starter-logging</artifactId>
68+
</dependency>
69+
70+
<dependency>
71+
<groupId>org.apache.logging.log4j</groupId>
72+
<artifactId>log4j-api</artifactId>
73+
</dependency>
74+
75+
<dependency>
76+
<groupId>org.apache.logging.log4j</groupId>
77+
<artifactId>log4j-core</artifactId>
78+
</dependency>
79+
80+
<!--dependencies app database-->
81+
<dependency>
82+
<groupId>org.postgresql</groupId>
83+
<artifactId>postgresql</artifactId>
84+
<version>42.7.4</version>
85+
</dependency>
86+
87+
<!--dependencies app documentation swagger-->
88+
<dependency>
89+
<groupId>org.springdoc</groupId>
90+
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
91+
<version>2.5.0</version>
92+
</dependency>
93+
94+
<dependency>
95+
<groupId>org.springdoc</groupId>
96+
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
97+
<version>2.3.0</version>
98+
</dependency>
99+
100+
<!--dependencies app documentation swagger-->
101+
<dependency>
102+
<groupId>org.springframework.boot</groupId>
103+
<artifactId>spring-boot-configuration-processor</artifactId>
104+
</dependency>
105+
106+
<!--dependencies app documentation swagger-->
107+
<dependency>
108+
<groupId>org.springframework.boot</groupId>
109+
<artifactId>spring-boot-devtools</artifactId>
110+
</dependency>
111+
112+
<dependency>
113+
<groupId>org.projectlombok</groupId>
114+
<artifactId>lombok</artifactId>
115+
<version>1.18.34</version>
116+
</dependency>
117+
118+
<dependency>
119+
<groupId>org.mapstruct</groupId>
120+
<artifactId>mapstruct</artifactId>
121+
<version>1.5.4.Final</version>
122+
</dependency>
123+
124+
<dependency>
125+
<groupId>org.modelmapper</groupId>
126+
<artifactId>modelmapper</artifactId>
127+
<version>3.2.0</version>
128+
</dependency>
129+
130+
<!--dependencies app test-->
131+
<dependency>
132+
<groupId>org.springframework.boot</groupId>
133+
<artifactId>spring-boot-starter-test</artifactId>
134+
</dependency>
135+
136+
<dependency>
137+
<groupId>com.h2database</groupId>
138+
<artifactId>h2</artifactId>
139+
</dependency>
140+
141+
</dependencies>
142+
143+
<build>
144+
<plugins>
145+
<plugin>
146+
<groupId>org.apache.maven.plugins</groupId>
147+
<artifactId>maven-compiler-plugin</artifactId>
148+
<configuration>
149+
<source>${java.version}</source>
150+
<target>${java.version}</target>
151+
<encoding>UTF-8</encoding>
152+
<annotationProcessorPaths>
153+
<path>
154+
<groupId>org.projectlombok</groupId>
155+
<artifactId>lombok</artifactId>
156+
<version>1.18.34</version>
157+
</path>
158+
<path>
159+
<groupId>org.mapstruct</groupId>
160+
<artifactId>mapstruct-processor</artifactId>
161+
<version>1.5.4.Final</version>
162+
</path>
163+
</annotationProcessorPaths>
164+
</configuration>
165+
</plugin>
166+
</plugins>
167+
</build>
10168
</project>

‎src/main/resources/archetype-resources/src/main/resources/application.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ server:
1010
netty:
1111
idle-timeout: 5000
1212
connection-timeout: 6000
13+
servlet:
14+
context-path: /archetype-example/v1
1315

1416
# app spring configuration:
1517
spring:
1618
application:
17-
name: ${artifactId}
18-
webflux:
19-
base-path: /${artifactId}/v1
19+
name: archetype-example
2020
banner:
2121
location: 'classpath:/banner.txt'
2222
main:

‎src/main/resources/archetype-resources/src/main/resources/banner.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
13
d8888b. .d8b. .o88b. .d8888. db db .d8888. d888888b d88888b .88b d88.
24
88 `8D d8' `8b d8P Y8 88' YP `8b d8' 88' YP `~~88~~' 88' 88'YbdP`88
35
88oooY' 88ooo88 8P `8bo. `8bd8' `8bo. 88 88ooooo 88 88 88

0 commit comments

Comments
 (0)