Swagger - param 세부설명 작성

src/main/java/com/palnet/biz/api/acnt/crtfyhp/controller/AcntCrtfyhpController.java

@@ -3,7 +3,12 @@ package com.palnet.biz.api.acnt.crtfyhp.controller;
 import java.util.HashMap;
 import java.util.Map;
 
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -29,6 +34,7 @@ import lombok.extern.log4j.Log4j2;
 @RestController
 @RequiredArgsConstructor
 @RequestMapping(value = "/api/acnt/crtfyhp", produces = {MediaType.APPLICATION_JSON_VALUE})
+@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
 public class AcntCrtfyhpController {
 	
 	@Autowired
@@ -39,6 +45,8 @@ public class AcntCrtfyhpController {
 	
 	
 	@GetMapping(value = "/register/send")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParam(name = "hnpo",value = "휴대폰번호")
 	public ResponseEntity<? extends BasicResponse> send(String hpno) {
 		
 		
@@ -79,6 +87,11 @@ public class AcntCrtfyhpController {
 	
 
 	@GetMapping(value = "/register/confirm")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "hpno",value = "휴대폰번호"),
+			@ApiImplicitParam(name = "crtfyNo",value = "인증일련번호")
+	})
 	public ResponseEntity<? extends BasicResponse> confirm(String hpno , String crtfyNo) {
 		
 		
@@ -110,6 +123,11 @@ public class AcntCrtfyhpController {
 	//아이디 찾기 시 인증번호 발송 로직
 	@GetMapping(value = "/find/sendForId")
 	@ApiOperation(value = "아이디 찾기 시 인증번호 발송")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "memberName", value = "회원 이름"),
+			@ApiImplicitParam(name = "hpno", value = "휴대폰 번호")
+	})
 	public ResponseEntity<? extends BasicResponse> sendForId(String memberName, String hpno) {
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		
@@ -137,6 +155,11 @@ public class AcntCrtfyhpController {
 	//아이디 찾기
 	@GetMapping(value = "/find/findUserId")
 	@ApiOperation(value = "회원 아이디 찾기")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "memberName",value = "회원이름"),
+			@ApiImplicitParam(name = "hpno",value = "휴대폰번호")
+	})
 	public ResponseEntity<? extends BasicResponse> findUserId(String memberName, String hpno) {
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		
@@ -166,6 +189,11 @@ public class AcntCrtfyhpController {
 	//비밀번호 찾기 시 인증번호 발송 로직
 	@GetMapping(value = "/find/sendForPw")
 	@ApiOperation(value = "비밀번호 찾기 시 인증번호 발송")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "userId",value = "사용자ID"),
+			@ApiImplicitParam(name = "hpno",value = "휴대폰번호")
+	})
 	public ResponseEntity<? extends BasicResponse> sendForPw(String userId, String hpno) {
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		
@@ -194,6 +222,12 @@ public class AcntCrtfyhpController {
 
 	@GetMapping(value = "/find/updatePw")
 	@ApiOperation(value = "비밀번호 찾기 및 업데이트")
+	@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API")
+	@ApiImplicitParams({
+			@ApiImplicitParam(name = "userID",value = "사용자ID"),
+			@ApiImplicitParam(name = "hpno",value = "휴대폰번호"),
+			@ApiImplicitParam(name = "newPw",value = "새로운 비밀번호")
+	})
 	public ResponseEntity<? extends BasicResponse> updatePw(String userId, String hpno, String newPw) throws Exception {
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		

src/main/java/com/palnet/biz/api/acnt/cstmr/controller/AcntCstmrController.java

@@ -11,7 +11,11 @@ import com.palnet.biz.api.acnt.cstmr.model.AcntCstmrEmModel;
 import com.palnet.biz.api.acnt.cstmr.model.AcntCstmrGroupModel;
 import com.palnet.biz.api.acnt.cstmr.model.AcntCstmrPwModel;
 
+import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -46,6 +50,7 @@ import lombok.extern.log4j.Log4j2;
 @RestController
 @RequiredArgsConstructor
 @RequestMapping(value = "/api/acnt/cstmr", produces = {MediaType.APPLICATION_JSON_VALUE})
+@Tag(name = "회원관리", description = "회원 관련 API")
 public class AcntCstmrController {
 	
 	@Autowired
@@ -53,6 +58,7 @@ public class AcntCstmrController {
 	
 	@PostMapping(value = "/register")
 	@ApiOperation(value = "회원 가입")
+	@Tag(name = "회원관리", description = "회원 관련 API")
 	public ResponseEntity<? extends BasicResponse> register(@RequestBody AcntCstmrRqModel rq) {
 		
 		AcntCstmrRsModel result;
@@ -74,6 +80,8 @@ public class AcntCstmrController {
 	
 	@GetMapping(value = "/profile/{cstmrSno}")
 	@ApiOperation(value = "회원 정보")
+	@Tag(name = "회원관리", description = "회원 관련 API")
+	@ApiImplicitParam(name = "cstmrSno",value = "고객일련번호")
 	public ResponseEntity<? extends BasicResponse> mypage(@PathVariable Integer cstmrSno){
 		List<AnctCstmerRlModel> result = null;
 		
@@ -93,6 +101,7 @@ public class AcntCstmrController {
 	
 	@PostMapping(value = "/profile/pswdupdate")
 	@ApiOperation(value = "회원 패스워드 변경")
+	@Tag(name = "회원관리", description = "회원 관련 API")
 	public ResponseEntity<? extends BasicResponse> passwordupdate(@RequestBody AcntCstmrPwModel rq){
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		try {
@@ -115,6 +124,7 @@ public class AcntCstmrController {
 	
 	@PutMapping(value = "/profile/update")
 	@ApiOperation(value = "회원 정보 변경 (이메일,핸드폰)")
+	@Tag(name = "회원관리", description = "회원 관련 API")
 	public ResponseEntity<? extends BasicResponse> updateEmail(@RequestBody AcntCstmrEmModel rq){
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		try {
@@ -139,6 +149,8 @@ public class AcntCstmrController {
 	
 	@PostMapping(value = "/profile/delete/{cstmrSno}")
 	@ApiOperation(value = "회원 탈퇴")
+	@Tag(name = "회원관리", description = "회원 관련 API")
+	@ApiImplicitParam(name = "cstmrSno",value = "고객일련번호")
 	public ResponseEntity<? extends BasicResponse> userDelete(@PathVariable Integer cstmrSno){
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		try {

src/main/java/com/palnet/biz/api/acnt/jwt/controller/JwtAuthenticationController.java

@@ -3,7 +3,10 @@ package com.palnet.biz.api.acnt.jwt.controller;
 import java.util.HashMap;
 import java.util.Map;
 
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -41,6 +44,7 @@ import lombok.extern.log4j.Log4j2;
 @RequiredArgsConstructor
 @Log4j2
 @RequestMapping(value = "/api/acnt/jwt", produces = {MediaType.APPLICATION_JSON_VALUE})
+@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API")
 public class JwtAuthenticationController {
 
 	@Autowired
@@ -55,6 +59,7 @@ public class JwtAuthenticationController {
 		
 	@PostMapping(value = "/login")
 	@ApiOperation(value = "로그인")
+	@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API")
 	public ResponseEntity<? extends BasicResponse> createAuthenticationToken(@RequestBody JwtRqModel authenticationRequest) throws Exception {
 		
 		Map<String , Object> resultMap = service.loginProcess(authenticationRequest);
@@ -78,6 +83,8 @@ public class JwtAuthenticationController {
 	
 	@GetMapping(value = "/profile/{cstmrSno}")
 	@ApiOperation(value = "로그인한 회원의 정보")
+	@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API")
+	@ApiImplicitParam(name = "cstmrSno",value = "고객일련번호")
 	public ResponseEntity<? extends BasicResponse> proflie(@PathVariable int cstmrSno) throws Exception{
 		
 		JwtProfileRsModel result = service.profile(cstmrSno);
@@ -90,6 +97,7 @@ public class JwtAuthenticationController {
 	
 	
 	@PostMapping(value = "/refresh")
+	@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API")
 //	public ResponseEntity<? extends BasicResponse> refresh(@RequestParam("cstmrSno") int cstmrSno , @RequestParam("refreshToken") String refreshToken) throws Exception{
 		public ResponseEntity<? extends BasicResponse> refresh(@RequestBody Map body) throws Exception{
 		
@@ -118,6 +126,8 @@ public class JwtAuthenticationController {
 	
 	@GetMapping(value = "/logout/{cstmrSno}")
 	@ApiOperation(value = "로그아웃 한 회원의 정보")
+	@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API")
+	@ApiImplicitParam(name = "cstmrSno",value = "고객일련번호")
 	public ResponseEntity<? extends BasicResponse> logout(@PathVariable int cstmrSno) throws Exception{
 		
 //		if(cstmrSno == null || !(body.get("cstmrSno") instanceof Integer)) {

src/main/java/com/palnet/biz/api/acnt/terms/controller/AcntTermsController.java

@@ -2,6 +2,8 @@ package com.palnet.biz.api.acnt.terms.controller;
 
 import java.util.List;
 
+import io.swagger.annotations.ApiOperation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -35,6 +37,7 @@ import lombok.extern.log4j.Log4j2;
 @RestController
 @RequiredArgsConstructor
 @RequestMapping(value = "/api/acnt/terms", produces = {MediaType.APPLICATION_JSON_VALUE})
+@Tag(name = "약관 기본", description = "약관 관련 API")
 public class AcntTermsController {
 	
 	@Autowired
@@ -43,6 +46,8 @@ public class AcntTermsController {
 	
 	
 	@GetMapping(value = "/list")
+	@Tag(name = "약관 기본", description = "약관 관련 API")
+	@ApiOperation(value = "약관 기본 정보")
 	public ResponseEntity<? extends BasicResponse> list(AcntTermsRqModel rq) {
 		List<AcntTermsRsModel> result = null;
 		

src/main/java/com/palnet/biz/api/ctr/cntrl/service/CtrCntrlService.java

@@ -2,6 +2,7 @@ package com.palnet.biz.api.ctr.cntrl.service;
 
 import java.util.*;
 
+import ch.qos.logback.core.encoder.EchoEncoder;
 import com.palnet.biz.api.bas.flight.model.BasFlightPlanAreaCoordModel;
 import com.palnet.biz.api.bas.flight.model.BasFlightPlanAreaModel;
 import com.palnet.biz.api.bas.flight.model.BasFlightPlanModel;
@@ -17,6 +18,7 @@ import com.palnet.biz.jpa.repository.ctr.CtrCntrlWarnLogRepository;
 import com.palnet.biz.jpa.repository.flt.*;
 import com.palnet.comn.utils.AreaUtils;
 import com.palnet.comn.utils.DateUtils;
+import com.palnet.comn.utils.EncryptUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.locationtech.jts.geom.Coordinate;
 
@@ -103,6 +105,7 @@ public class CtrCntrlService {
 		
 		List<CtrCntrlHstryArea> areaList = query.detailArea(controlId);
 		String stAreaNm = "";
+		result.setHpno(EncryptUtils.decrypt(result.getHpno()));
 		
 		for(CtrCntrlHstryArea data : areaList) {
 			if(data.getActnType().equals("01")) {
@@ -128,6 +131,7 @@ public class CtrCntrlService {
 			}
 		}
 
+		
 		result.setStAreaNm(stAreaNm);
 		
 		return result;