From 705663da49a042d407492ca8f774d6ccf326dd07 Mon Sep 17 00:00:00 2001
From: minuk926 <minuk926@gmail.com>
Date: Tue, 18 Apr 2023 12:41:36 +0900
Subject: [PATCH] feat: swagger2 set

---
 pom.xml                                       | 15 ++++
 .../framework/core/config/Swagger2Config.java | 85 +++++++++++++++++++
 src/main/resources/spring/context-mvc.xml     |  1 +
 .../resources/spring/mvc/mvc-swagger2.xml     | 11 +++
 .../spring/service/context-security.xml       | 13 +++
 src/main/webapp/WEB-INF/web.xml               |  7 ++
 6 files changed, 132 insertions(+)
 create mode 100644 src/main/java/kr/xit/framework/core/config/Swagger2Config.java
 create mode 100644 src/main/resources/spring/mvc/mvc-swagger2.xml

diff --git a/pom.xml b/pom.xml
index ef8ba247..8ef7ec2e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -208,6 +208,21 @@
 			</exclusions>
 		</dependency>
 
+
+		<!-- swagger2 -->
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>2.9.2</version>
+		</dependency>
+
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>2.9.2</version>
+		</dependency>
+		<!-- swagger2 -->
+
 		<dependency>
 			<groupId>org.thymeleaf</groupId>
 			<artifactId>thymeleaf</artifactId>
diff --git a/src/main/java/kr/xit/framework/core/config/Swagger2Config.java b/src/main/java/kr/xit/framework/core/config/Swagger2Config.java
new file mode 100644
index 00000000..574c5f97
--- /dev/null
+++ b/src/main/java/kr/xit/framework/core/config/Swagger2Config.java
@@ -0,0 +1,85 @@
+package kr.xit.framework.core.config;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+@Configuration
+@EnableSwagger2
+@EnableWebMvc
+public class Swagger2Config {
+    // @Bean
+    // public Docket api() {
+    //     return new Docket(DocumentationType.SWAGGER_2)
+    //             .apiInfo(apiInfo())
+    //             .select()
+    //             //.apis(RequestHandlerSelectors.any())
+    //             .apis(RequestHandlerSelectors.basePackage("kr.xit.fims"))
+    //             // .paths(PathSelectors.regex("/"))
+    //             //.paths(PathSelectors.any())
+    //             .paths(PathSelectors.ant("/**"))
+    //             .build();
+    // }
+
+    @Bean
+    public Docket newsApiAll() {
+        return new Docket(DocumentationType.SWAGGER_2)
+            .groupName("01. FIMS Biz API REST Service")
+            .consumes(getConsumeContentTypes())
+            .produces(getProduceContentTypes())
+            .apiInfo(apiInfo())
+            .select()
+            .apis(RequestHandlerSelectors.basePackage("kr.xit.fims"))
+            .paths(PathSelectors.ant("/**"))
+            .build();
+    }
+
+    @Bean
+    public Docket newsApiAccelerator() {
+        return new Docket(DocumentationType.SWAGGER_2)
+            .groupName("02. Framework Biz API REST Service")
+            .consumes(getConsumeContentTypes())
+            .produces(getProduceContentTypes())
+            .apiInfo(apiInfo())
+            .select()
+            .apis(RequestHandlerSelectors.basePackage("kr.xit.framework"))
+            .paths(PathSelectors.ant("/**"))
+            .build();
+    }
+
+
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder()
+                .title("통합플랫폼 Rest API Documentation")
+                .description("통합플랫폼 Rest api 서비스")
+                .termsOfServiceUrl("https://www.egovframe.go.kr/wiki/doku.php?id=egovframework:hyb:gate_page")
+                .license("Apache License Version 2.0")
+                .licenseUrl("https://www.egovframe.go.kr")
+                .version("0.1")
+                .build();
+    }
+
+    private Set<String> getConsumeContentTypes() {
+        Set<String> consumes = new HashSet<>();
+        consumes.add("application/json;charset=UTF-8");
+        consumes.add("application/x-www-form-urlencoded");
+        return consumes;
+    }
+
+    private Set<String> getProduceContentTypes() {
+        Set<String> produces = new HashSet<>();
+        produces.add("application/json;charset=UTF-8");
+        return produces;
+    }
+}
diff --git a/src/main/resources/spring/context-mvc.xml b/src/main/resources/spring/context-mvc.xml
index d4d1ce42..02057e8f 100644
--- a/src/main/resources/spring/context-mvc.xml
+++ b/src/main/resources/spring/context-mvc.xml
@@ -29,6 +29,7 @@
 	<import resource="classpath:/spring/mvc/mvc-interceptor.xml" />
 	<import resource="classpath:/spring/mvc/mvc-resolver.xml" />
 	<import resource="classpath:/spring/mvc/mvc-converter.xml" />
+	<import resource="classpath:/spring/mvc/mvc-swagger2.xml" />
 
 
 </beans>
diff --git a/src/main/resources/spring/mvc/mvc-swagger2.xml b/src/main/resources/spring/mvc/mvc-swagger2.xml
new file mode 100644
index 00000000..978fe140
--- /dev/null
+++ b/src/main/resources/spring/mvc/mvc-swagger2.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:mvc="http://www.springframework.org/schema/mvc"
+       xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
+                http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
+
+    <mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
+    <mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
+    <mvc:resources location="/resources/" mapping="/resources/**"/>
+
+</beans>
diff --git a/src/main/resources/spring/service/context-security.xml b/src/main/resources/spring/service/context-security.xml
index 0a74e504..b58eb129 100644
--- a/src/main/resources/spring/service/context-security.xml
+++ b/src/main/resources/spring/service/context-security.xml
@@ -20,6 +20,19 @@
 	<security:http pattern="/framework/biz/mng/usr/addUser.do" security="none"/>
 	<security:http pattern="/framework/biz/mng/usr/addUserPopup.do" security="none"/>
  	<security:http pattern="\A/WEB-INF/jsp/.*\Z" request-matcher="regex" security="none"/>
+
+
+	<!-- swagger2 set -->
+	<security:http pattern="/swagger-ui.html/**" security="none"/>
+	<security:http pattern="/swagger/**" security="none"/>
+	<security:http pattern="/swagger-resources/**" security="none"/>
+	<security:http pattern="/v2/api-docs" security="none"/>
+	<security:http pattern="/v3/api-docs" security="none"/>
+	<security:http pattern="/webjars/**" security="none"/>
+	<!-- swagger2 set -->
+
+
+<!--		<security:http pattern="/webjars/springfox-swagger-ui/*.{js,css}" security="none"/>-->
  	
  	<!-- 전자정부 프레임워크 사용 시 -->
 <!--     <egov-security:config id="securityConfig" -->
diff --git a/src/main/webapp/WEB-INF/web.xml b/src/main/webapp/WEB-INF/web.xml
index f05f759a..5e56071e 100644
--- a/src/main/webapp/WEB-INF/web.xml
+++ b/src/main/webapp/WEB-INF/web.xml
@@ -121,6 +121,13 @@
         <servlet-name>action</servlet-name>
         <url-pattern>*.do</url-pattern>
 	    <url-pattern>*.ajax</url-pattern>
+
+        <!-- swagger2 set-->
+        <url-pattern>/swagger-ui.html</url-pattern>
+        <url-pattern>/webjars/**</url-pattern>
+        <url-pattern>/</url-pattern>
+        <!-- swagger2 set-->
+
     </servlet-mapping>
 
     <!-- Ubi Report Servlet -->