瀏覽代碼

중간 커밋

sungwoobaek@idatabank.com 5 年之前
父節點
當前提交
effbfc307b

+ 2 - 0
.gitignore

@@ -0,0 +1,2 @@
+consentApi/bin/main/com/dbs/consentServer/config/SwaggerConfiguration.class
+consentApi/bin/main/com/dbs/consentServer/controller/ConsentSvc.class

二進制
.gradle/6.3/fileChanges/last-build.bin


二進制
.gradle/6.3/fileHashes/fileHashes.lock


+ 0 - 0
.gradle/6.3/gc.properties


二進制
.gradle/checksums/checksums.lock


+ 0 - 0
.gradle/vcs-1/gc.properties


+ 3 - 0
.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "java.configuration.updateBuildConfiguration": "automatic"
+}

二進制
consentApi/bin/main/com/dbs/consentServer/controller/ConsentSvc.class


+ 4 - 0
consentApi/build.gradle

@@ -24,6 +24,10 @@ dependencies {
 	implementation("org.mybatis.spring.boot:mybatis-spring-boot-starter:2.1.1")
 	implementation("org.bgee.log4jdbc-log4j2:log4jdbc-log4j2-jdbc4.1:1.16")
 	implementation("com.oracle:ojdbc6:11.2.0.3")
+
+  // SWAGGER
+	implementation 'io.springfox:springfox-swagger2:2.6.1'
+	implementation 'io.springfox:springfox-swagger-ui:2.6.1'
 }
 
 test {

+ 31 - 0
consentApi/src/main/java/com/dbs/consentServer/config/SwaggerConfiguration.java

@@ -0,0 +1,31 @@
+package com.dbs.consentServer.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+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
+public class SwaggerConfiguration {
+    @Bean
+    public Docket swaggerApi() {
+        return new Docket(DocumentationType.SWAGGER_2).apiInfo(swaggerInfo()).select()
+                .apis(RequestHandlerSelectors.basePackage("com.dbs.consentServer"))
+                .paths(PathSelectors.any())
+                .build()
+                .useDefaultResponseMessages(false); // 기본으로 세팅되는 200,401,403,404 메시지를 표시 하지 않음
+    }
+
+    private ApiInfo swaggerInfo() {
+        return new ApiInfoBuilder().title("Spring API Documentation")
+                .description("앱 개발시 사용되는 서버 API에 대한 연동 문서입니다")
+                .license("Databanksystems").licenseUrl("http://www.idatabank.com/").version("1").build();
+    }
+}

+ 5 - 0
consentApi/src/main/java/com/dbs/consentServer/controller/ConsentSvc.java

@@ -6,9 +6,13 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
 import com.dbs.consentServer.consentVO.TestVO;
 import com.dbs.consentServer.service.TestService;
 
+@Api(tags = {"1. ConsentService "})
 @RestController
 public class ConsentSvc {
   
@@ -22,6 +26,7 @@ public class ConsentSvc {
   @Autowired
   TestService testService;
 
+  @ApiOperation(value = "테스트 URI", notes = "테스트 URI 입니다.")
   @RequestMapping(value = "/test")
   public void test() throws Exception {
     logger.error("test");