swagger feature:

add swagger for show all api controller for checking and testing

Author: PouyaPouryaie

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>ir.bigz</groupId>
 	<artifactId>springboot-real</artifactId>
-	<version>0.0.4</version>
+	<version>0.1.4</version>
 	<name>basicFeaturesForSpringProject</name>
 	<description>Demo project for use Spring Boot in project</description>
 
@@ -125,6 +125,19 @@
 			<optional>true</optional>
 		</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,13 +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.EnableAutoConfiguration;
 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;
+
 //TODO add pagination to dao
 //TODO complex model
 
@@ -22,4 +30,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

@@ -20,4 +20,12 @@ spring.cache.jcache.config=classpath:ehcache.xml
 
 ################### default connection pool ##########################
 spring.datasource.hikari.connectionTimeout=20000
-spring.datasource.hikari.maximumPoolSize=5
+spring.datasource.hikari.maximumPoolSize=5
+
+################### 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
+