main feature:

merge with swagger and test feature

Author: PouyaPouryaie

README.md

@@ -17,6 +17,10 @@ this project, implement instance of basic feature, <br> you maybe want use for A
     - use annotation for validation
     - use log for validation error
     - define your validation and use for model
+- TestUtils
+  - generator data with javaFaker
+  - unit and integration test with <b>Spock</b> Framework
+  - SwaggerAPI for show detail of Rest endpoint
 - decoupling layer
     - controller, service and repository layer for easy extend
 - flexible search
@@ -27,6 +31,7 @@ this project, implement instance of basic feature, <br> you maybe want use for A
 1 - check active profile on dev <br>
 2 - run postgre sql on 5432 and create database myapp <br>
 3 - run app <br>
+4 - app.generator.enabled properties set to true, when you want to generate fake data <br>
 
 ### Run as docker image: <br>
 1 - check active profile on docker and package project <br>
@@ -53,4 +58,10 @@ this project, implement instance of basic feature, <br> you maybe want use for A
 1 - create your own search model <br>
 2 - use pagination for search <br>
 3 - create query dynamic base on search request <br>
-4 - use order and direction for sort data <br>
+4 - use order and direction for sort data <br>
+
+### test feature
+1 - generate sample data baseOn model with javaFaker <br>
+2 - Spock framework use for test <br>
+3 - sample test define in test directory with groovy language <br>
+4 - Swagger Api for show details of endpoints <br>

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>ir.bigz</groupId>
 	<artifactId>springboot-real</artifactId>
-	<version>0.0.4</version>
+	<version>0.1.5</version>
 	<name>basicFeaturesForSpringProject</name>
 	<description>Demo project for use Spring Boot in project</description>
 
@@ -153,6 +153,19 @@
 			<version>3.0.8</version>
 		</dependency>
 
+		<!--   swagger-UI   -->
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-ui</artifactId>
+			<version>1.5.10</version>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-webmvc-core</artifactId>
+			<version>1.5.10</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>

src/main/java/ir/bigz/springbootreal/SpringbootRealApplication.java

@@ -1,12 +1,21 @@
 package ir.bigz.springbootreal;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
+import org.springframework.context.annotation.Bean;
 import org.springframework.transaction.annotation.EnableTransactionManagement;
 
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+
 @SpringBootApplication(exclude = {
 		DataSourceAutoConfiguration.class,
 		HibernateJpaAutoConfiguration.class,
@@ -18,4 +27,20 @@ public static void main(String[] args) {
 		SpringApplication.run(SpringbootRealApplication.class, args);
 	}
 
+	@Autowired
+	ObjectMapper mapper;
+
+    @Bean
+    public OpenAPI customOpenAPI(@Value("${application-description}") String appDesciption, @Value("${application-version}") String appVersion) {
+     return new OpenAPI()
+          .info(new Info()
+          .title("Sample Application API")
+          .version(appVersion)
+          .description(appDesciption)
+          .termsOfService("http://swagger.io/terms/")
+          .license(new License().name("Apache 2.0").url("http://springdoc.org")));
+    }
+
+
+
 }

src/main/resources/application-dev.properties

@@ -1,7 +1,6 @@
 ################### Server Configuration ##########################
 server.port=9090
 
-
 ################### DataSource Configuration ##########################
 demo.datasource.driver-class-name=org.postgresql.Driver
 demo.datasource.url=jdbc:postgresql://localhost:5432/myapp
@@ -20,4 +19,11 @@ spring.datasource.hikari.connectionTimeout=20000
 spring.datasource.hikari.maximumPoolSize=5
 
 ################### condition Configuration ##########################
-app.generator.enabled=false
+app.generator.enabled=false
+
+################### Application MetaData ##########################
+application-description=@project.description@
+application-version=@project.version@
+springdoc.swagger-ui.path=/swagger-ui.html
+springdoc.api-docs.path=/api-docs
+springdoc.use-fqn=true