Fixing the updates of Swagger dependencies to version 3.0.0.

mariazevedo88 · Jul 30, 2020 · 93991be · 93991be
1 parent fe32dfd
commit 93991be
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 29 deletions.
diff --git a/Procfile b/Procfile
@@ -1 +1 @@
-web: java -jar -Dspring.profiles.active=prod -Dserver.port=$PORT target/financial-java-api-3.0.2-SNAPSHOT.jar
+web: java -jar -Dspring.profiles.active=prod -Dserver.port=$PORT target/financial-java-api-3.0.3-SNAPSHOT.jar
diff --git a/README.md b/README.md
@@ -158,14 +158,14 @@ All `BigDecimal` values always contain exactly two decimal places, eg: `15.385`
 This project was developed with:
 
 * **Java 11 (Java Development Kit - JDK: 11.0.7)**
-* **Spring Boot 2.3.0**
+* **Spring Boot 2.3.2**
 * **Spring Admin Client 2.2.3**
 * **Maven**
 * **JUnit 5**
 * **Surfire**
 * **PostgreSQL 12**
 * **Flyway 6.4.1**
-* **Swagger 2.10.5**
+* **Swagger 3.0.0**
 * **Model Mapper 2.3.8**
 * **Heroku**
 * **EhCache**
@@ -179,7 +179,7 @@ The API also was developed to run with an `jar`. In order to generate this `jar`
 mvn package
 ```
 
-It will clean, compile and generate a `jar` at target directory, e.g. `financial-java-api-3.0.2-SNAPSHOT.jar`
+It will clean, compile and generate a `jar` at target directory, e.g. `financial-java-api-3.0.3-SNAPSHOT.jar`
 
 ### Execution
 
@@ -217,7 +217,7 @@ mvn integration-test
 In order to run the API, run the jar simply as following:
 
 ```bash
-java -jar financial-java-api-3.0.2-SNAPSHOT.jar --spring.profiles.active=prod
+java -jar financial-java-api-3.0.3-SNAPSHOT.jar --spring.profiles.active=prod
 ```
 
 or
@@ -230,7 +230,7 @@ By default, the API will be available at [http://localhost:8080/financial/v1](ht
 
 ### Documentation
 
-* Swagger (development environment): http://localhost:8080/swagger-ui.html
+* Swagger (development environment): http://localhost:8080/swagger-ui/index.html
 
 #### Medium Articles
 

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
 	<groupId>io.github.mariazevedo88</groupId>
 	<artifactId>financial-java-api</artifactId>
-	<version>3.0.2-SNAPSHOT</version>
+	<version>3.0.3-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<name>financial-java-api</name>
@@ -21,7 +21,7 @@
 
 	<properties>
 		<java.version>11</java.version>
-		<swagger.version>2.10.5</swagger.version>
+		<swagger.version>3.0.0</swagger.version>
 		<modelmapper.version>2.3.8</modelmapper.version>
 		<bucket4j.version>4.10.0</bucket4j.version>
 		<spring.admin.version>2.2.3</spring.admin.version>
@@ -68,6 +68,16 @@
 		    <groupId>org.springframework.boot</groupId>
 		    <artifactId>spring-boot-starter-actuator</artifactId>
 		</dependency>
+		<dependency>
+		    <groupId>io.springfox</groupId>
+		    <artifactId>springfox-boot-starter</artifactId>
+		    <version>${swagger.version}</version>
+		</dependency>
+		<dependency>
+		    <groupId>de.codecentric</groupId>
+		    <artifactId>spring-boot-admin-starter-client</artifactId>
+		    <version>${spring.admin.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
@@ -87,16 +97,6 @@
 		    <groupId>org.flywaydb</groupId>
 		    <artifactId>flyway-core</artifactId>
 		</dependency>
-		<dependency>
-		    <groupId>io.springfox</groupId>
-		    <artifactId>springfox-swagger2</artifactId>
-		    <version>${swagger.version}</version>
-		</dependency>
-		<dependency>
-		    <groupId>io.springfox</groupId>
-		    <artifactId>springfox-swagger-ui</artifactId>
-		    <version>${swagger.version}</version>
-		</dependency>
 		<dependency>
 		  <groupId>org.modelmapper</groupId>
 		  <artifactId>modelmapper</artifactId>
@@ -115,11 +115,6 @@
 		    <artifactId>bucket4j-core</artifactId>
 		    <version>${bucket4j.version}</version>
 		</dependency>
-		<dependency>
-		    <groupId>de.codecentric</groupId>
-		    <artifactId>spring-boot-admin-starter-client</artifactId>
-		    <version>${spring.admin.version}</version>
-		</dependency>
 	</dependencies>
 
 	<build>

diff --git a/src/main/java/io/github/mariazevedo88/financialjavaapi/util/config/SwaggerConfiguration.java b/src/main/java/io/github/mariazevedo88/financialjavaapi/util/config/SwaggerConfiguration.java
@@ -1,5 +1,6 @@
 package io.github.mariazevedo88.financialjavaapi.util.config;
 
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
@@ -10,7 +11,7 @@
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
-import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
 /**
  * Class that implements the necessary settings for using Swagger as an API documentation tool.
@@ -20,9 +21,15 @@
  */
 @Configuration
 @Profile({"dev"})
-@EnableSwagger2WebMvc
+@EnableSwagger2
 public class SwaggerConfiguration {
 
+	@Value("${release.version}")
+	private String releaseVersion;
+
+	@Value("${api.version}")
+	private String apiVersion;
+
 	/**
 	 * Method that configure all the endpoint's mapped in the documentation.
 	 * 
@@ -49,7 +56,7 @@ public Docket api() {
 	 */
 	private ApiInfo apiInfo() {
 		return new ApiInfoBuilder().title("Financial Java API")
-				.description("Financial Java API - Endpoint's documentation").version("1.0.0")
+				.description("Financial Java API - Endpoint's documentation").version(releaseVersion.concat("_").concat(apiVersion))
 				.build();
 	}
 

diff --git a/src/main/resources/application-prod.properties b/src/main/resources/application-prod.properties
@@ -18,7 +18,7 @@ pagination.items_per_page=10
 jwt.secret=oioqowepjsjdasd!$%mknfskdnf090192019
 jwt.expiration=6000
 
-api.version=2020-07-29
+api.version=2020-07-30
 api.key="FX001-FREE"
 
 #Enable response compression

diff --git a/src/main/resources/application-test.properties b/src/main/resources/application-test.properties
@@ -14,7 +14,7 @@ spring.cache.jcache.config=classpath:cache/ehcache.xml
 spring.mvc.throw-exception-if-no-handler-found=true
 spring.mvc.resources.add-mappings=false
 
-api.version=2020-07-29
+api.version=2020-07-30
 api.key="FX001-FREE"
 
 #Enable response compression

diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -21,7 +21,8 @@ pagination.items_per_page=10
 jwt.secret=qweernadnamdn19820918209!#ajhad
 jwt.expiration=3600
 
-api.version=2020-07-29
+release.version=3.0.3
+api.version=2020-07-30
 api.key="FX001-FREE"
 
 #Enable response compression