From dc12a6a3e3dbe7088b54a1bb02cfc98cf7c230c0 Mon Sep 17 00:00:00 2001
From: jhjang <jhjang@maprex.co.kr>
Date: 목, 06 1월 2022 10:43:41 +0900
Subject: [PATCH] - 코드 주석 추가
---
src/main/java/kr/wisestone/owl/config/SwaggerConfig.java | 22 ++++++++++++++++++++++
1 files changed, 22 insertions(+), 0 deletions(-)
diff --git a/src/main/java/kr/wisestone/owl/config/SwaggerConfig.java b/src/main/java/kr/wisestone/owl/config/SwaggerConfig.java
index 999f236..ab42cb3 100644
--- a/src/main/java/kr/wisestone/owl/config/SwaggerConfig.java
+++ b/src/main/java/kr/wisestone/owl/config/SwaggerConfig.java
@@ -17,6 +17,9 @@
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
+/**
+ * API 臾몄꽌 �젣�옉 �뙣�궎吏� Swagger �꽕�젙 �겢�옒�뒪
+ */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@@ -25,6 +28,11 @@
private static final String API_VERSION = "1.0.0";
private static final String API_DESCRIPTION = "OWL API 紐낆꽭�꽌";
+
+ /**
+ * API �꽕�젙
+ * @return docket class
+ */
@Bean
public Docket api() {
// Parameter parameterBuilder = new ParameterBuilder()
@@ -49,6 +57,11 @@
.build();
}
+
+ /**
+ * API 臾몄꽌 ���씠��/踰꾩쟾/�꽕紐� �꽕�젙
+ * @return ApiInfo �겢�옒�뒪
+ */
public ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(API_NAME)
@@ -57,6 +70,11 @@
.build();
}
+
+ /**
+ * API 臾몄꽌 �뀒�뒪�듃 Request Content-Type �꽕�젙 異붽�
+ * @return consumes content-type 紐⑸줉
+ */
private Set<String> getConsumeContentTypes() {
Set<String> consumes = new HashSet<>();
consumes.add("application/json;charset=UTF-8");
@@ -64,6 +82,10 @@
return consumes;
}
+ /**
+ * API 臾몄꽌 �뀒�뒪�듃 Response content-type �꽕�젙 異붽�
+ * @return produce content-type 紐⑸줉
+ */
private Set<String> getProduceContentTypes() {
Set<String> produces = new HashSet<>();
produces.add("application/json;charset=UTF-8");
--
Gitblit v1.8.0