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/web/form/ApiIssueAddForm.java | 5 ++
src/main/java/kr/wisestone/owl/web/form/ApiIssueModifyForm.java | 4 +
src/main/java/kr/wisestone/owl/web/controller/ApiTokenController.java | 20 +++++++++
src/main/java/kr/wisestone/owl/web/form/ApiTokenForm.java | 8 +--
src/main/java/kr/wisestone/owl/web/form/IssueApiForm.java | 2
src/main/java/kr/wisestone/owl/config/SwaggerConfig.java | 22 +++++++++++
src/main/java/kr/wisestone/owl/web/controller/Api/ApiController.java | 14 +------
src/main/java/kr/wisestone/owl/web/condition/IssueCustomFieldValueCondition.java | 14 ++++++-
8 files changed, 66 insertions(+), 23 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");
diff --git a/src/main/java/kr/wisestone/owl/web/condition/IssueCustomFieldValueCondition.java b/src/main/java/kr/wisestone/owl/web/condition/IssueCustomFieldValueCondition.java
index d364f3a..5475ac0 100644
--- a/src/main/java/kr/wisestone/owl/web/condition/IssueCustomFieldValueCondition.java
+++ b/src/main/java/kr/wisestone/owl/web/condition/IssueCustomFieldValueCondition.java
@@ -10,6 +10,7 @@
import java.util.Map;
/**
+ * �씠�뒋 �궗�슜�옄 �젙�쓽 �븘�뱶 媛� 寃��깋 議곌굔 �겢�옒�뒪
* Created by wisestone on 2018-06-07.
*/
public class IssueCustomFieldValueCondition {
@@ -17,9 +18,18 @@
private Long workspaceId;
private Long customFieldId;
private String customFieldType;
- private List<String> useValues = Lists.newArrayList(); // �떒�씪, �떎以� �씪�븣 寃��깋 媛�
- private String useValue; // �뀓�뒪�듃 �븘�뱶�씪 �븣 寃��깋 媛�
+ /**
+ * �궗�슜�옄 �젙�쓽 �븘�뱶 �궗�슜 媛�
+ */
+ private List<String> useValues = Lists.newArrayList();
+ /**
+ * �뀓�뒪�듃 �븘�뱶�씪 �븣 寃��깋 媛�
+ */
+ private String useValue;
private boolean useParentIssueId = true;
+ /**
+ * �씠�뒋 �긽�깭 �쑀�삎(READY / OPEN / CLOSE)
+ */
private String issueStatusType;
public IssueCustomFieldValueCondition(){}
diff --git a/src/main/java/kr/wisestone/owl/web/controller/Api/ApiController.java b/src/main/java/kr/wisestone/owl/web/controller/Api/ApiController.java
index 60a23f1..0fbbf81 100644
--- a/src/main/java/kr/wisestone/owl/web/controller/Api/ApiController.java
+++ b/src/main/java/kr/wisestone/owl/web/controller/Api/ApiController.java
@@ -34,6 +34,7 @@
/**
+ * �씠�뒋 異붽�
* @param apiIssueAddForm �엯�젰 �뤌 �뜲�씠�꽣
* @param files �뙆�씪
* @return JSON
@@ -68,6 +69,7 @@
}
/**
+ * �씠�뒋 �긽�깭 �닔�젙
* @param apiIssueModifyForm �닔�젙 �뤌 �뜲�씠�꽣
* @return JSON
* @throws OwlRuntimeException �뙆�씪誘명꽣 �삤瑜섏떆 諛쒖깮
@@ -92,17 +94,5 @@
return this.setSuccessMessage(resJsonData);
}
-
- // �씠�뒋 議고쉶
-// @RequestMapping(value = "/api/issueList", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
-// public
-// @ResponseBody
-// Map<String, Object> find(@RequestBody Map<String, Map<String, Object>> params) {
-// Map<String, Object> resJsonData = new HashMap<>();
-// Pageable pageable = this.pageUtil.convertPageable(this.getPageVo(params));
-//
-// // todo
-// return this.setSuccessMessage(resJsonData);
-// }
}
diff --git a/src/main/java/kr/wisestone/owl/web/controller/ApiTokenController.java b/src/main/java/kr/wisestone/owl/web/controller/ApiTokenController.java
index 11ba2b5..625f7c6 100644
--- a/src/main/java/kr/wisestone/owl/web/controller/ApiTokenController.java
+++ b/src/main/java/kr/wisestone/owl/web/controller/ApiTokenController.java
@@ -21,13 +21,20 @@
import java.util.List;
import java.util.Map;
+/**
+ * API �넗�겙 而⑦듃濡ㅻ윭 �겢�옒�뒪
+ */
@Controller
public class ApiTokenController extends BaseController {
@Autowired
private ApiTokenService apiTokenService;
- // �넗�겙 �깮�꽦
+ /**
+ * �넗�겙 �깮�꽦
+ * @param params �넗�겙 �깮�꽦�뿉 �븘�슂�븳 �뙆�씪誘명꽣
+ * @return �깮�꽦 寃곌낵 Map<String, Object>
+ */
@RequestMapping(value = "/apiToken/add", produces = MediaType.APPLICATION_JSON_VALUE)
public
@ResponseBody
@@ -42,6 +49,12 @@
return this.setSuccessMessage(resJsonData);
}
+
+ /**
+ * �넗�겙 議고쉶
+ * @param params �넗�겙 議고쉶�뿉 �븘�슂�븳 �뙆�씪誘명꽣
+ * @return 議고쉶 寃곌낵, Map<String, ApiTokenVo>
+ */
// �넗�겙 議고쉶
@RequestMapping(value = "/apiToken/find", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public
@@ -56,6 +69,11 @@
return this.setSuccessMessage(resJsonData);
}
+ /**
+ * �넗�겙 �궘�젣
+ * @param params �넗�겙 �궘�젣�뿉 �븘�슂�븳 �뙆�씪誘명꽣
+ * @return �궘�젣 寃곌낵, Map<String, Object>
+ */
// �넗�겙 �궘�젣
@RequestMapping(value = "/apiToken/remove", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
public
diff --git a/src/main/java/kr/wisestone/owl/web/form/ApiIssueAddForm.java b/src/main/java/kr/wisestone/owl/web/form/ApiIssueAddForm.java
index f25ebda..9a8d273 100644
--- a/src/main/java/kr/wisestone/owl/web/form/ApiIssueAddForm.java
+++ b/src/main/java/kr/wisestone/owl/web/form/ApiIssueAddForm.java
@@ -1,8 +1,11 @@
package kr.wisestone.owl.web.form;
-import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiParam;
+
+/**
+ * API �씠�뒋 異붽��슜 Form class
+ */
public class ApiIssueAddForm {
@ApiParam(value = "�궗�슜�옄 �넗�겙", required = true)
private String token;
diff --git a/src/main/java/kr/wisestone/owl/web/form/ApiIssueModifyForm.java b/src/main/java/kr/wisestone/owl/web/form/ApiIssueModifyForm.java
index 86a30b0..4a3be36 100644
--- a/src/main/java/kr/wisestone/owl/web/form/ApiIssueModifyForm.java
+++ b/src/main/java/kr/wisestone/owl/web/form/ApiIssueModifyForm.java
@@ -2,8 +2,10 @@
import io.swagger.annotations.ApiParam;
-import java.io.Serializable;
+/**
+ * API �씠�뒋 �긽�깭 �닔�젙�슜 Form class
+ */
public class ApiIssueModifyForm {
@ApiParam(value = "�궗�슜�옄 �넗�겙", required = true)
private String token;
diff --git a/src/main/java/kr/wisestone/owl/web/form/ApiTokenForm.java b/src/main/java/kr/wisestone/owl/web/form/ApiTokenForm.java
index ab0b978..281ddea 100644
--- a/src/main/java/kr/wisestone/owl/web/form/ApiTokenForm.java
+++ b/src/main/java/kr/wisestone/owl/web/form/ApiTokenForm.java
@@ -1,13 +1,11 @@
package kr.wisestone.owl.web.form;
-import com.google.common.collect.Lists;
import kr.wisestone.owl.domain.User;
-import kr.wisestone.owl.util.ConvertUtil;
-import kr.wisestone.owl.util.MapUtil;
-import java.util.List;
-import java.util.Map;
+/**
+ * API �넗�겙 Form class
+ */
public class ApiTokenForm {
private Long id;
private User user;
diff --git a/src/main/java/kr/wisestone/owl/web/form/IssueApiForm.java b/src/main/java/kr/wisestone/owl/web/form/IssueApiForm.java
index bd24d7c..9ab2b02 100644
--- a/src/main/java/kr/wisestone/owl/web/form/IssueApiForm.java
+++ b/src/main/java/kr/wisestone/owl/web/form/IssueApiForm.java
@@ -8,7 +8,7 @@
import java.util.*;
/**
- *
+ * API �씠�뒋 異붽� / �닔�젙�슜 form class
*/
public class IssueApiForm implements Serializable {
--
Gitblit v1.8.0