From fb4d218b8181ba8b0c3e70617076dacabab0c9db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?leehagjoon=28=EC=9D=B4=ED=95=99=EC=A4=80=29?= Date: Fri, 15 Sep 2023 17:18:02 +0900 Subject: [PATCH] =?UTF-8?q?[LDRA]=20113S=20:=20=EC=BD=94=EB=93=9C=EC=9D=98?= =?UTF-8?q?=20=EB=B9=84=20=ED=91=9C=EC=A4=80=20=EB=AC=B8=EC=9E=90=20-=20?= =?UTF-8?q?=EB=AA=A8=EB=93=A0=20=EB=82=B4=EC=9A=A9=EC=97=90=20=ED=95=9C?= =?UTF-8?q?=EA=B8=80=EC=9D=B4=20=EB=93=A4=EC=96=B4=EA=B0=80=EB=A9=B4=20?= =?UTF-8?q?=EC=95=88=EB=90=9C=EB=8B=A4.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../controller/AcntCrtfyhpController.java | 41 +++++++-------- .../cstmr/controller/AcntCstmrController.java | 25 ++++----- .../acnt/cstmr/service/AcntCstmrService.java | 2 +- .../JwtAuthenticationController.java | 17 +++--- .../terms/controller/AcntTermsController.java | 6 +-- .../hstry/controller/AnlsHstryController.java | 16 +++--- .../smlt/controller/AnlsSmltController.java | 21 ++++---- .../dron/controller/BasDronController.java | 35 +++++-------- .../controller/BasFlightController.java | 52 +++++++------------ .../controller/BasGroupAprvController.java | 9 ++-- .../group/controller/BasGroupController.java | 40 ++++++-------- .../controller/BasGroupJoinController.java | 12 ++--- .../controller/BasGroupUserController.java | 12 ++--- .../cntrl/controller/CtrCntrlController.java | 48 +++++++---------- .../dash/controller/MainDashController.java | 23 ++++---- .../com/palnet/biz/config/SwaggerConfig.java | 2 + 16 files changed, 149 insertions(+), 212 deletions(-) diff --git a/src/main/java/com/palnet/biz/api/acnt/crtfyhp/controller/AcntCrtfyhpController.java b/src/main/java/com/palnet/biz/api/acnt/crtfyhp/controller/AcntCrtfyhpController.java index fc47b74..0fbfde1 100644 --- a/src/main/java/com/palnet/biz/api/acnt/crtfyhp/controller/AcntCrtfyhpController.java +++ b/src/main/java/com/palnet/biz/api/acnt/crtfyhp/controller/AcntCrtfyhpController.java @@ -3,6 +3,7 @@ package com.palnet.biz.api.acnt.crtfyhp.controller; import java.util.HashMap; import java.util.Map; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; @@ -34,7 +35,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/acnt/crtfyhp", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") +@Api(tags = {"Mobile Phone Authentication API"} , value = "AcntCrtfyhpController") public class AcntCrtfyhpController { @Autowired @@ -45,8 +46,7 @@ public class AcntCrtfyhpController { @GetMapping(value = "/register/send") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") - @ApiImplicitParam(name = "hnpo",value = "휴대폰번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "hnpo",value = "hnpo", dataTypeClass = String.class) public ResponseEntity send(String hpno) { @@ -87,10 +87,9 @@ public class AcntCrtfyhpController { @GetMapping(value = "/register/confirm") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") @ApiImplicitParams({ - @ApiImplicitParam(name = "hpno",value = "휴대폰번호", dataTypeClass = String.class), - @ApiImplicitParam(name = "crtfyNo",value = "인증일련번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "hpno",value = "hpno", dataTypeClass = String.class), + @ApiImplicitParam(name = "crtfyNo",value = "crtfyNo", dataTypeClass = String.class) }) public ResponseEntity confirm(String hpno , String crtfyNo) { @@ -122,11 +121,10 @@ public class AcntCrtfyhpController { //아이디 찾기 시 인증번호 발송 로직 @GetMapping(value = "/find/sendForId") - @ApiOperation(value = "아이디 찾기 시 인증번호 발송") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") + @ApiOperation(value = "Find Id and Send crftyNo") @ApiImplicitParams({ - @ApiImplicitParam(name = "memberName", value = "회원 이름", dataTypeClass = String.class), - @ApiImplicitParam(name = "hpno", value = "휴대폰 번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "memberName", value = "memberName", dataTypeClass = String.class), + @ApiImplicitParam(name = "hpno", value = "hpno", dataTypeClass = String.class) }) public ResponseEntity sendForId(String memberName, String hpno) { Map resultMap = new HashMap(); @@ -154,11 +152,10 @@ public class AcntCrtfyhpController { //아이디 찾기 @GetMapping(value = "/find/findUserId") - @ApiOperation(value = "회원 아이디 찾기") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") + @ApiOperation(value = "Find Member Id") @ApiImplicitParams({ - @ApiImplicitParam(name = "memberName",value = "회원이름", dataTypeClass = String.class), - @ApiImplicitParam(name = "hpno",value = "휴대폰번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "memberName",value = "memberName", dataTypeClass = String.class), + @ApiImplicitParam(name = "hpno",value = "hpno", dataTypeClass = String.class) }) public ResponseEntity findUserId(String memberName, String hpno) { Map resultMap = new HashMap(); @@ -188,11 +185,10 @@ public class AcntCrtfyhpController { //비밀번호 찾기 시 인증번호 발송 로직 @GetMapping(value = "/find/sendForPw") - @ApiOperation(value = "비밀번호 찾기 시 인증번호 발송") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") + @ApiOperation(value = "Find PW and Send crtfyNo") @ApiImplicitParams({ - @ApiImplicitParam(name = "userId",value = "사용자ID", dataTypeClass = String.class), - @ApiImplicitParam(name = "hpno",value = "휴대폰번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "userId",value = "userId", dataTypeClass = String.class), + @ApiImplicitParam(name = "hpno",value = "hpno", dataTypeClass = String.class) }) public ResponseEntity sendForPw(String userId, String hpno) { Map resultMap = new HashMap(); @@ -221,12 +217,11 @@ public class AcntCrtfyhpController { @GetMapping(value = "/find/updatePw") - @ApiOperation(value = "비밀번호 찾기 및 업데이트") - @Tag(name = "휴대폰 인증 관리", description = "회원 휴대폰 인증 관련 API") + @ApiOperation(value = "Find PW and UPDATE PW") @ApiImplicitParams({ - @ApiImplicitParam(name = "userID",value = "사용자ID", dataTypeClass = String.class), - @ApiImplicitParam(name = "hpno",value = "휴대폰번호", dataTypeClass = String.class), - @ApiImplicitParam(name = "newPw",value = "새로운 비밀번호", dataTypeClass = String.class) + @ApiImplicitParam(name = "userID",value = "userID", dataTypeClass = String.class), + @ApiImplicitParam(name = "hpno",value = "hpno", dataTypeClass = String.class), + @ApiImplicitParam(name = "newPw",value = "newPw", dataTypeClass = String.class) }) public ResponseEntity updatePw(String userId, String hpno, String newPw) throws Exception { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/acnt/cstmr/controller/AcntCstmrController.java b/src/main/java/com/palnet/biz/api/acnt/cstmr/controller/AcntCstmrController.java index beac1eb..367b751 100644 --- a/src/main/java/com/palnet/biz/api/acnt/cstmr/controller/AcntCstmrController.java +++ b/src/main/java/com/palnet/biz/api/acnt/cstmr/controller/AcntCstmrController.java @@ -11,6 +11,7 @@ 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.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.Parameter; @@ -50,15 +51,14 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/acnt/cstmr", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "회원관리", description = "회원 관련 API") +@Api(tags = {"Member Management API"}, value = "AcntCstmrController") public class AcntCstmrController { @Autowired private final AcntCstmrService service; @PostMapping(value = "/register") - @ApiOperation(value = "회원 가입") - @Tag(name = "회원관리", description = "회원 관련 API") + @ApiOperation(value = "Join User") public ResponseEntity register(@RequestBody AcntCstmrRqModel rq) { AcntCstmrRsModel result; @@ -79,9 +79,8 @@ public class AcntCstmrController { } @GetMapping(value = "/profile/{cstmrSno}") - @ApiOperation(value = "회원 정보") - @Tag(name = "회원관리", description = "회원 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "User Info") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity mypage(@PathVariable Integer cstmrSno){ List result = null; @@ -100,8 +99,7 @@ public class AcntCstmrController { } @PostMapping(value = "/profile/pswdupdate") - @ApiOperation(value = "회원 패스워드 변경") - @Tag(name = "회원관리", description = "회원 관련 API") + @ApiOperation(value = "Password Update") public ResponseEntity passwordupdate(@RequestBody AcntCstmrPwModel rq){ Map resultMap = new HashMap(); try { @@ -123,8 +121,7 @@ public class AcntCstmrController { } @PostMapping(value = "/profile/pwcheck") - @ApiOperation(value = "회원 기존 패스워드 확인") - @Tag(name = "회원관리", description = "회원 관련 API") + @ApiOperation(value = "Member Check Existing PW") public ResponseEntity extendpsw(@RequestBody Map userPswdMap){ Map resultMap = new HashMap(); try { @@ -146,8 +143,7 @@ public class AcntCstmrController { } @PutMapping(value = "/profile/update") - @ApiOperation(value = "회원 정보 변경 (이메일,핸드폰)") - @Tag(name = "회원관리", description = "회원 관련 API") + @ApiOperation(value = "Member Info update EMAIL,HPNO") public ResponseEntity updateEmail(@RequestBody AcntCstmrEmModel rq){ Map resultMap = new HashMap(); try { @@ -171,9 +167,8 @@ public class AcntCstmrController { } @PostMapping(value = "/profile/delete/{cstmrSno}") - @ApiOperation(value = "회원 탈퇴") - @Tag(name = "회원관리", description = "회원 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Member Delete") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity userDelete(@PathVariable Integer cstmrSno){ Map resultMap = new HashMap(); try { diff --git a/src/main/java/com/palnet/biz/api/acnt/cstmr/service/AcntCstmrService.java b/src/main/java/com/palnet/biz/api/acnt/cstmr/service/AcntCstmrService.java index 69bcee2..dc8d794 100644 --- a/src/main/java/com/palnet/biz/api/acnt/cstmr/service/AcntCstmrService.java +++ b/src/main/java/com/palnet/biz/api/acnt/cstmr/service/AcntCstmrService.java @@ -244,7 +244,7 @@ public class AcntCstmrService { // 4. RQ의 암호화한 패스워드와 DB에서 조회한 유저의 패스워드랑 비교 if(!userPswd.equals(userEntity.getUserPswd())) { - log.info("USERPSWD 비밀번호 : {}, DB 비밀번호 : {}", userPswd, userEntity.getUserPswd()); + log.info("USERPSWD PW : {}, DB PW : {}", userPswd, userEntity.getUserPswd()); // 4.e 일치하지 않으면 예외처리 (패스워드 불일치) throw new CustomException(ErrorCode.FAIL); // 임시,, 수정해야함 diff --git a/src/main/java/com/palnet/biz/api/acnt/jwt/controller/JwtAuthenticationController.java b/src/main/java/com/palnet/biz/api/acnt/jwt/controller/JwtAuthenticationController.java index 8bb6518..75b65b7 100644 --- a/src/main/java/com/palnet/biz/api/acnt/jwt/controller/JwtAuthenticationController.java +++ b/src/main/java/com/palnet/biz/api/acnt/jwt/controller/JwtAuthenticationController.java @@ -3,6 +3,7 @@ package com.palnet.biz.api.acnt.jwt.controller; import java.util.HashMap; import java.util.Map; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; @@ -44,7 +45,7 @@ import lombok.extern.log4j.Log4j2; @RequiredArgsConstructor @Log4j2 @RequestMapping(value = "/api/acnt/jwt", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API") +@Api(tags = {"JWT API"},value = "JwtAuthenticationController") public class JwtAuthenticationController { @Autowired @@ -58,8 +59,7 @@ public class JwtAuthenticationController { private JwtService service; @PostMapping(value = "/login") - @ApiOperation(value = "로그인") - @Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API") + @ApiOperation(value = "login") public ResponseEntity createAuthenticationToken(@RequestBody JwtRqModel authenticationRequest) throws Exception { Map resultMap = service.loginProcess(authenticationRequest); @@ -82,9 +82,8 @@ public class JwtAuthenticationController { } @GetMapping(value = "/profile/{cstmrSno}") - @ApiOperation(value = "로그인한 회원의 정보") - @Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "login user Info") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity proflie(@PathVariable Integer cstmrSno) throws Exception{ JwtProfileRsModel result = service.profile(cstmrSno); @@ -97,7 +96,6 @@ public class JwtAuthenticationController { @PostMapping(value = "/refresh") - @Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API") // public ResponseEntity refresh(@RequestParam("cstmrSno") int cstmrSno , @RequestParam("refreshToken") String refreshToken) throws Exception{ public ResponseEntity refresh(@RequestBody Map body) throws Exception{ @@ -125,9 +123,8 @@ public class JwtAuthenticationController { } @GetMapping(value = "/logout/{cstmrSno}") - @ApiOperation(value = "로그아웃 한 회원의 정보") - @Tag(name = "JWT 토큰 이용", description = "JWT 토큰 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "logout user Info") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity logout(@PathVariable Integer cstmrSno) throws Exception{ // if(cstmrSno == null || !(body.get("cstmrSno") instanceof Integer)) { diff --git a/src/main/java/com/palnet/biz/api/acnt/terms/controller/AcntTermsController.java b/src/main/java/com/palnet/biz/api/acnt/terms/controller/AcntTermsController.java index 11a30aa..060c26f 100644 --- a/src/main/java/com/palnet/biz/api/acnt/terms/controller/AcntTermsController.java +++ b/src/main/java/com/palnet/biz/api/acnt/terms/controller/AcntTermsController.java @@ -2,6 +2,7 @@ package com.palnet.biz.api.acnt.terms.controller; import java.util.List; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.beans.factory.annotation.Autowired; @@ -37,7 +38,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/acnt/terms", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "약관 기본", description = "약관 관련 API") +@Api(value = "AcntTermsController", tags = {"Terms Basic API"}) public class AcntTermsController { @Autowired @@ -46,8 +47,7 @@ public class AcntTermsController { @GetMapping(value = "/list") - @Tag(name = "약관 기본", description = "약관 관련 API") - @ApiOperation(value = "약관 기본 정보") + @ApiOperation(value = "Terms Info") public ResponseEntity list(AcntTermsRqModel rq) { List result = null; diff --git a/src/main/java/com/palnet/biz/api/anls/hstry/controller/AnlsHstryController.java b/src/main/java/com/palnet/biz/api/anls/hstry/controller/AnlsHstryController.java index c44b708..f1932ad 100644 --- a/src/main/java/com/palnet/biz/api/anls/hstry/controller/AnlsHstryController.java +++ b/src/main/java/com/palnet/biz/api/anls/hstry/controller/AnlsHstryController.java @@ -3,6 +3,7 @@ package com.palnet.biz.api.anls.hstry.controller; import java.util.List; import com.palnet.biz.api.comn.model.ComnPagingRs; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; @@ -34,7 +35,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/anls/hstry", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") +@Api(value = "AnlsHstryController",tags = {"Flight History Status API"}) public class AnlsHstryController { @Autowired @@ -42,8 +43,7 @@ public class AnlsHstryController { @GetMapping(value = "/list") - @ApiOperation(value = "비행 현황 목록 출력") - @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") + @ApiOperation(value = "Flight Status List") public ResponseEntity list(AnlsHstryGroupModel rq) { List rs = null; ComnPagingRs response; @@ -68,9 +68,8 @@ public class AnlsHstryController { } @GetMapping(value = "/detail/{id}") - @ApiOperation(value = "비행 현황 상세") - @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "Flight Status Detail") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity detail(@PathVariable String id) { AnlsHstryModel result = null; @@ -89,9 +88,8 @@ public class AnlsHstryController { @GetMapping(value = "/log/{id}") - @ApiOperation(value = "비행 이력 데이터") - @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "Flight History Log") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity log(@PathVariable String id) { List result = null; try { diff --git a/src/main/java/com/palnet/biz/api/anls/smlt/controller/AnlsSmltController.java b/src/main/java/com/palnet/biz/api/anls/smlt/controller/AnlsSmltController.java index fd74a68..ddcc8ad 100644 --- a/src/main/java/com/palnet/biz/api/anls/smlt/controller/AnlsSmltController.java +++ b/src/main/java/com/palnet/biz/api/anls/smlt/controller/AnlsSmltController.java @@ -2,6 +2,7 @@ package com.palnet.biz.api.anls.smlt.controller; import java.util.List; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; @@ -35,7 +36,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/anls/smlt", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") +@Api(value = "AnlsSmltController",tags = {"Flight History Simulation API"}) public class AnlsSmltController { @Autowired @@ -47,8 +48,7 @@ public class AnlsSmltController { * @return */ @GetMapping(value = "/list") - @ApiOperation(value = "비행 현황 목록") - @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") + @ApiOperation(value = "Flight status List") public ResponseEntity list(AnlsHstryRqModel rq) { ComnPagingRs result = null; @@ -82,9 +82,8 @@ public class AnlsSmltController { * @return */ @GetMapping(value = "/hist/{id}") - @ApiOperation(value = "비행 이력 데이터 조회") - @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "Flight History") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity histList(@PathVariable String id) { List result = null; @@ -109,9 +108,8 @@ public class AnlsSmltController { * @return */ @GetMapping(value = "/stcs/{id}") - @ApiOperation(value = "통계 데이터 조회") - @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "Query Statistical data") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity stcsList(@PathVariable String id) { List result = null; @@ -136,9 +134,8 @@ public class AnlsSmltController { * @return */ @GetMapping(value = "/detail/{id}") - @ApiOperation(value = "비행 상세정보 조회") - @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "Flight Detail") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity detail(@PathVariable String id) { AnlsSmltDetailModel result = null; diff --git a/src/main/java/com/palnet/biz/api/bas/dron/controller/BasDronController.java b/src/main/java/com/palnet/biz/api/bas/dron/controller/BasDronController.java index c16b0a8..3fa09a6 100644 --- a/src/main/java/com/palnet/biz/api/bas/dron/controller/BasDronController.java +++ b/src/main/java/com/palnet/biz/api/bas/dron/controller/BasDronController.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -40,7 +41,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/dron", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "드론 컨트롤러", description = "드론 관련 API") +@Api(value = "BasDronController",tags = {"Drone Information API"}) public class BasDronController { @Autowired @@ -53,8 +54,7 @@ public class BasDronController { * @return */ @GetMapping(value = "/list") - @ApiOperation(value = "드론 목록 조회") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiOperation(value = "Drone List") public ResponseEntity list(BasDronRqModel rq) { ComnPagingRs result = null; @@ -85,9 +85,8 @@ public class BasDronController { * @return */ @GetMapping(value = "/idntf/list/{id}") - @ApiOperation(value = "식별정보 조회") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") - @ApiImplicitParam(name = "id",value = "기체일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Idntf List") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = Integer.class) public ResponseEntity mylist(@PathVariable Integer id) { List result = null; @@ -118,9 +117,8 @@ public class BasDronController { * @return */ @GetMapping(value = "/detail/{id}") - @ApiOperation(value = "드론 상세 조회") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") - @ApiImplicitParam(name = "id",value = "기체일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Drone Detail") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = Integer.class) public ResponseEntity detail(@PathVariable Integer id) { BasDronModel result = null; @@ -150,8 +148,7 @@ public class BasDronController { * @return */ @PostMapping(value = "/create") - @ApiOperation(value = "드론정보 생성") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiOperation(value = "Create Drone Info") public ResponseEntity create(@RequestBody BasDronModel rq) { Map resultMap = new HashMap(); @@ -180,8 +177,7 @@ public class BasDronController { * @return */ @PostMapping(value = "/idntf/create") - @ApiOperation(value = "식별장치 생성") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiOperation(value = "Create Idntf") public ResponseEntity createIdntf(@RequestBody BasIdntfRqModel rq) { Map resultMap = new HashMap(); @@ -212,8 +208,7 @@ public class BasDronController { * @return */ @PutMapping(value = "/update") - @ApiOperation(value = "드론정보 수정") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiOperation(value = "Update Drone Info") public ResponseEntity update(@RequestBody BasDronModel rq) { Map resultMap = new HashMap(); @@ -244,9 +239,8 @@ public class BasDronController { * @return */ @DeleteMapping(value = "/delete/{id}") - @ApiOperation(value = "드론정보 삭제") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") - @ApiImplicitParam(name = "id",value = "기체일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Delete Drone Info") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = Integer.class) public ResponseEntity delete(@PathVariable Integer id) { Map resultMap = new HashMap(); @@ -278,9 +272,8 @@ public class BasDronController { * @return */ @DeleteMapping(value = "/idntf/delete/{id}") - @ApiOperation(value = "식별장치 삭제") - @Tag(name = "드론 컨트롤러", description = "드론 관련 API") - @ApiImplicitParam(name = "id",value = "식별번호", dataTypeClass = String.class) + @ApiOperation(value = "Delete Idntf") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity deleteIdntf(@PathVariable String id) { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/bas/flight/controller/BasFlightController.java b/src/main/java/com/palnet/biz/api/bas/flight/controller/BasFlightController.java index 4287d55..b26e0a4 100644 --- a/src/main/java/com/palnet/biz/api/bas/flight/controller/BasFlightController.java +++ b/src/main/java/com/palnet/biz/api/bas/flight/controller/BasFlightController.java @@ -11,6 +11,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import org.json.simple.JSONObject; import org.json.simple.parser.JSONParser; import org.json.simple.parser.ParseException; @@ -59,7 +60,7 @@ import lombok.extern.slf4j.Slf4j; @Slf4j @RestController @RequestMapping(value = "/api/bas/flight", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "비행계획서", description = "비행계획서 관련 API") +@Api(value = "BasFlightController",tags = {"Flight Plan API"}) public class BasFlightController { private final BasFlightService basFlightService; @@ -76,7 +77,6 @@ public class BasFlightController { } @GetMapping("/area") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity findAirSpace() throws IOException, ParseException { // 1. file read Resource resource = new ClassPathResource("air/airgeo.json"); @@ -101,8 +101,7 @@ public class BasFlightController { // 비행계획서 조회 @GetMapping(value = "/plan/list") - @ApiOperation(value = "비행계획서 조회") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Flight Plan List") public ResponseEntity findPlanList(BasFlightPlanListRq rq) { ComnPagingRs result = null; // System.out.println(rq); @@ -119,9 +118,8 @@ public class BasFlightController { // 비행계획서 상세 조회 @GetMapping(value = "/plan/detail/{planSno}") - @ApiOperation(value = "비행계획서 상세 조회") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") - @ApiImplicitParam(name = "planSno",value = "비행계획서일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Flight Plan Detail") + @ApiImplicitParam(name = "planSno",value = "planSno", dataTypeClass = Integer.class) public ResponseEntity detailPlan(@PathVariable("planSno") Integer planSno) { BasFlightPlanModel result = null; try { @@ -137,8 +135,7 @@ public class BasFlightController { // 비행계획서 등록 @PostMapping(value = "/plan/create") - @ApiOperation(value = "비행계획서 등록") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Create Flight Plan") public ResponseEntity createPlan(@RequestBody BasFlightPlanModel rq) { Map resultMap = new HashMap(); try { @@ -164,8 +161,7 @@ public class BasFlightController { // 비행계획서 수정 @PutMapping(value = "/plan/update") - @ApiOperation(value = "비행계획서 수정") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Update Flight Plan") public ResponseEntity updatePlan(@RequestBody BasFlightPlanModel rq) { Map resultMap = new HashMap(); try { @@ -189,9 +185,8 @@ public class BasFlightController { // 비행계획서 삭제 @DeleteMapping(value = "/plan/delete/{planSno}") - @ApiOperation(value = "비행계획서 삭제") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") - @ApiImplicitParam(name = "planSno",value = "비행계획서일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Delete Flight Plan") + @ApiImplicitParam(name = "planSno",value = "planSno", dataTypeClass = Integer.class) public ResponseEntity deletePlan(@PathVariable("planSno") Integer planSno) { Map resultMap = new HashMap(); try { @@ -214,9 +209,8 @@ public class BasFlightController { // 그룹 조종사 조회 @GetMapping(value = "/plan/pilot/{groupId}") - @ApiOperation(value = "그룹의 조종사 조회") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") - @ApiImplicitParam(name = "groupId",value = "그룹ID", dataTypeClass = String.class) + @ApiOperation(value = "Group Pilot List") + @ApiImplicitParam(name = "groupId",value = "groupId", dataTypeClass = String.class) public ResponseEntity findPilot(@PathVariable("groupId") String groupId) { List result = null; try { @@ -233,9 +227,8 @@ public class BasFlightController { } // 그룹 기체 조회 @GetMapping(value = "/plan/arcrft/{groupId}") - @ApiOperation(value = "그룹의 기체 조회") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") - @ApiImplicitParam(name = "groupId",value = "그룹ID", dataTypeClass = String.class) + @ApiOperation(value = "Group Arcrft") + @ApiImplicitParam(name = "groupId",value = "groupId", dataTypeClass = String.class) public ResponseEntity findArcrft(@PathVariable("groupId") String groupId) { List result = null; try { @@ -252,8 +245,7 @@ public class BasFlightController { // 비행 구역 버퍼 존 생성 @PostMapping("/plan/area/buffer") - @ApiOperation(value = "비행 구역 버퍼 존 생성") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Flight area buffer Create") public ResponseEntity findBuffer(@RequestBody List rq) { List rs = null; try { @@ -268,8 +260,7 @@ public class BasFlightController { } @GetMapping("/plan/api/weather") - @ApiOperation(value = "비행계획서 날씨") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Flight Plan Weather") public ResponseEntity restApiGetWeather(BasFlightWeatherModel rq){ JSONObject jsonObject = null; @@ -286,8 +277,7 @@ public class BasFlightController { } // 비행계획서 리스트(승인) @GetMapping(value = "/aprv/list") - @ApiOperation(value = "비행계획서 리스트(승인)") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Flight Plan Aprv List") public ResponseEntity findAprvList(BasFlightPlanListRq rq) { ComnPagingRs result = null; try { @@ -302,8 +292,7 @@ public class BasFlightController { } // 비행계획서 승인/미승인 @PutMapping(value = "/aprv/proc") - @ApiOperation(value = "비행 계획서 승인/미승인") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Flight Plan aprv/proc") public ResponseEntity updateAprvProc(@RequestBody BasFlightAprovRq rq) { Map resultMap = new HashMap(); try { @@ -326,7 +315,6 @@ public class BasFlightController { } @PostMapping("/airspace/contains") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity checkAirspaceContains(@RequestBody List rq) { Map resultMap = new HashMap(); try { @@ -345,14 +333,13 @@ public class BasFlightController { //지역 검색 @GetMapping("/plan/area/search") - @ApiOperation(value = "지역 검색") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiOperation(value = "Search area") public ResponseEntity searchArea(String query) throws ParseException { String text = null; try { text = URLEncoder.encode(query, "UTF-8"); } catch (UnsupportedEncodingException e) { - throw new RuntimeException("검색어 인코딩 실패", e); + throw new RuntimeException("Search Encoding Fail", e); } String apiURL = env.getProperty("api.naver.search-url") + "?query=" + text + "&display=5"; @@ -368,7 +355,6 @@ public class BasFlightController { } @GetMapping("/schedule") - @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity findSchedule(@RequestParam("searchDate") String searchDate) { List response; diff --git a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupAprvController.java b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupAprvController.java index 1848c94..ba52ee8 100644 --- a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupAprvController.java +++ b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupAprvController.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -33,7 +34,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/aprv", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") +@Api(value = "BasGroupAprvController", tags = {"Group Approval API"}) public class BasGroupAprvController { @Autowired @@ -45,8 +46,7 @@ public class BasGroupAprvController { * @return */ @GetMapping(value = "/list") - @ApiOperation(value = "승인요청 조회") - @Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") + @ApiOperation(value = "Aprov List") public ResponseEntity list(BasGroupAprvRqModel rq) { ComnPagingRs result = null; // log.debug(">>>>" + rq.toString()); @@ -76,8 +76,7 @@ public class BasGroupAprvController { * @return */ @PutMapping(value = "/update") - @ApiOperation(value = "승인처리 / 승인취소 처리") - @Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") + @ApiOperation(value = "Update Aprov / cancellAprov") public ResponseEntity update(@RequestBody BasGroupAprvModel rq) { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupController.java b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupController.java index 076ffb3..a535c74 100644 --- a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupController.java +++ b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupController.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; @@ -38,15 +39,14 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") +@Api(value = "BasGroupController", tags = {"Group API"}) public class BasGroupController { @Autowired private final BasGroupService service; @GetMapping(value = "/createid") - @ApiOperation(value = "그룹코드 생성") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiOperation(value = "Create Group ID") public ResponseEntity createid() { Map resultMap = new HashMap(); @@ -71,9 +71,8 @@ public class BasGroupController { * @return */ @GetMapping(value = "/mylist") - @ApiOperation(value = "나의 그룹 목록 조회") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "My Group List") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity mylist(Integer cstmrSno) { List result = null; @@ -105,9 +104,8 @@ public class BasGroupController { * @return */ @GetMapping(value = "/joinlist") - @ApiOperation(value = "나의 그룹 - 참여 그룹 목록 조회") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "My Group - Join Groups List") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity joinList(Integer cstmrSno) { List result = null; @@ -138,9 +136,8 @@ public class BasGroupController { * @return */ @GetMapping(value = "/grouplist") - @ApiOperation(value = "그룹 목록 조회") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Group List") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity grouplist(Integer cstmrSno) { List result = null; @@ -171,8 +168,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/list") - @ApiOperation(value = "전체 그룹 목록 조회") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiOperation(value = "All Group List") public ResponseEntity list(BasGroupRqModel rq) { List result = null; @@ -196,9 +192,8 @@ public class BasGroupController { * @return */ @GetMapping(value = "/detail/{id}") - @ApiOperation(value = "그룹 상세 조회") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") - @ApiImplicitParam(name = "id",value = "그룹ID", dataTypeClass = String.class) + @ApiOperation(value = "Group Detail") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity detail(@PathVariable String id) { BasGroupModel result = null; @@ -222,8 +217,7 @@ public class BasGroupController { * @throws Exception */ @PostMapping(value = "/create") - @ApiOperation(value = "그룹 생성") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiOperation(value = "Create Group") public ResponseEntity create(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -249,8 +243,7 @@ public class BasGroupController { * @throws Exception */ @PutMapping(value = "/update") - @ApiOperation(value = "그룹 수정") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiOperation(value = "Update Group") public ResponseEntity update(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -282,9 +275,8 @@ public class BasGroupController { * @return */ @DeleteMapping(value = "/delete/{id}") - @ApiOperation(value = "그룹 삭제") - @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") - @ApiImplicitParam(name = "id",value = "그룹ID", dataTypeClass = String.class) + @ApiOperation(value = "Delete Group") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity delete(@PathVariable String id) { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupJoinController.java b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupJoinController.java index 102db38..6a95611 100644 --- a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupJoinController.java +++ b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupJoinController.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.beans.factory.annotation.Autowired; @@ -33,7 +34,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/join", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") +@Api(value = "BasGroupJoinController", tags = {"Join Group API"}) public class BasGroupJoinController { @Autowired @@ -41,8 +42,7 @@ public class BasGroupJoinController { @GetMapping(value = "/list") - @ApiOperation(value = "참여한 그룹 목록 조회") - @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") + @ApiOperation(value = "Join Group List") public ResponseEntity list(BasGroupJoinRqModel rq) { List result = null; @@ -67,8 +67,7 @@ public class BasGroupJoinController { @PostMapping(value = "/create") - @ApiOperation(value = "그룹 가입 요청") - @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") + @ApiOperation(value = "Group Request to Join") public ResponseEntity create(@RequestBody BasGroupJoinModel rq) { Map resultMap = new HashMap(); @@ -88,8 +87,7 @@ public class BasGroupJoinController { } @PutMapping(value = "/update") - @ApiOperation(value = "그룹 가입 승인/미승인") - @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") + @ApiOperation(value = "Group Join Aprov/NoAprov") public ResponseEntity update(@RequestBody BasGroupJoinModel rq) { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupUserController.java b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupUserController.java index 998fdff..72a3adf 100644 --- a/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupUserController.java +++ b/src/main/java/com/palnet/biz/api/bas/group/controller/BasGroupUserController.java @@ -4,6 +4,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -34,7 +35,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/user", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") +@Api(value = "BasGroupUserController", tags = {"User Group API"}) public class BasGroupUserController { @Autowired @@ -42,8 +43,7 @@ public class BasGroupUserController { @GetMapping(value = "/list") - @ApiOperation(value = "그룹 사용자 조회") - @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") + @ApiOperation(value = "Group User List") public ResponseEntity list(BasGroupUserListModel rq) { ComnPagingRs result = null; @@ -68,8 +68,7 @@ public class BasGroupUserController { @PutMapping(value = "/update") - @ApiOperation(value = "그룹 사용자 권한 수정") - @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") + @ApiOperation(value = "Group User Auth Update") public ResponseEntity update(@RequestBody BasGroupUserModel rq) { Map resultMap = new HashMap(); @@ -89,8 +88,7 @@ public class BasGroupUserController { } @PutMapping(value = "/delegate") - @ApiOperation(value = "MASTER 권한 위임") - @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") + @ApiOperation(value = "MASTER Auth Delegate") public ResponseEntity delegate(@RequestBody List rq) { Map resultMap = new HashMap(); diff --git a/src/main/java/com/palnet/biz/api/ctr/cntrl/controller/CtrCntrlController.java b/src/main/java/com/palnet/biz/api/ctr/cntrl/controller/CtrCntrlController.java index 1f97199..fd65cfd 100644 --- a/src/main/java/com/palnet/biz/api/ctr/cntrl/controller/CtrCntrlController.java +++ b/src/main/java/com/palnet/biz/api/ctr/cntrl/controller/CtrCntrlController.java @@ -13,6 +13,7 @@ import java.util.*; import com.palnet.biz.api.ctr.cntrl.model.*; import com.palnet.biz.scheduler.ctr.model.CtrTrnsLctnModel; import com.palnet.biz.scheduler.ctr.service.CtrTrnsLctnService; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; @@ -37,7 +38,7 @@ import lombok.extern.log4j.Log4j2; @Log4j2 @RestController @RequestMapping(value = "/api/ctr/cntrl", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") +@Api(value = "CtrCntrlController", tags = {"Drone Control System API"}) public class CtrCntrlController { private final CtrCntrlService service; @@ -53,9 +54,8 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/history/{id}") - @ApiOperation(value = "TODO 드론 관제 이력 목록 (Socket 분리 전)") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "TODO Drone Control Histroy") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity historyList(@PathVariable String id) { List result = null; @@ -78,9 +78,8 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/detail/{id}") - @ApiOperation(value = "TODO 드론 관제 상세 정보") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "TODO Drone Control Detail") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity detail(@PathVariable String id) { CtrCntrlDtlModel result = null; @@ -103,9 +102,8 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/history/list/{id}") - @ApiOperation(value = "TODO 드론 관제 '실시간' 이력 목록") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "TODO Drone Control 'Real-Time' History List") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity history(@PathVariable String id) { List history; @@ -120,8 +118,7 @@ public class CtrCntrlController { } @GetMapping("/api/weather") - @ApiOperation(value = "드론 관제 날씨") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiOperation(value = "Drone Control Weather") public ResponseEntity restApiGetWeather(CtrCntrlWeatherModel rq) throws IOException, ParseException { JSONObject jsonObject = null; try { @@ -140,9 +137,8 @@ public class CtrCntrlController { * @return */ @GetMapping("/group") - @ApiOperation(value = "TODO 비행 관제 사용자 권한 정보") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "TODO Flight Control User Auth Info") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity findGroupAuthInfo(int cstmrSno) { List list; @@ -164,9 +160,8 @@ public class CtrCntrlController { * @return */ @GetMapping("/flight_plan/{idntfNum}") - @ApiOperation(value = "TODO 비행 관제 사용자 비행 계획서 정보") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "idtfNum",value = "식별번호", dataTypeClass = String.class) + @ApiOperation(value = "TODO Flight Control User Plan Info") + @ApiImplicitParam(name = "idtfNum",value = "idtfNum", dataTypeClass = String.class) public ResponseEntity findFlightPlan(@PathVariable("idntfNum") String idntfNum) { List list; @@ -188,9 +183,8 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/warn/detail/{id}") - @ApiOperation(value = "TODO 드론 운행 시작 후 알람 목록") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") - @ApiImplicitParam(name = "id",value = "관제ID", dataTypeClass = String.class) + @ApiOperation(value = "TODO Drone Fly Start and Alarm List") + @ApiImplicitParam(name = "id",value = "id", dataTypeClass = String.class) public ResponseEntity warnDetail(@PathVariable String id){ List warnLog; @@ -211,8 +205,7 @@ public class CtrCntrlController { * @return */ @PostMapping(value = "/arcrft/warn/list") - @ApiOperation(value = "TODO 기체 별 최신 비정상 로그 및 비정상 로그 전체 개수") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiOperation(value = "TODO Arcrft Warn List") public ResponseEntity arcrftWarnList(@RequestBody CtrCntrlArcrftWarnRqModel rq){ // public ResponseEntity arcrftWarnList(@RequestParam("id") String id){ List arcrftWarnList; @@ -235,8 +228,7 @@ public class CtrCntrlController { * @return */ @PostMapping("/contains") - @ApiOperation(value = "TODO 비행 관제 구역 비정상 상황 체크") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiOperation(value = "TODO Flight Control area Anomaly Check") public ResponseEntity checkPlanContains(@RequestBody CtrCntrlPlanContainsRq rq) { CtrCntrlPlanContainsRs rs; @@ -258,8 +250,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/id/{id}") - @ApiOperation(value = "TODO 실시간 Control ID 발급") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiOperation(value = "TODO RealTime Control Id Issue") public ResponseEntity getId(@PathVariable String id) { Map result; try { @@ -281,8 +272,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/warn/{id}/{lat}/{lon}") - @ApiOperation(value = "TODO 비행 관제 기체의 비정상 상황 확인") - @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiOperation(value = "TODO Flight Control Aircraft Warring Check") public ResponseEntity checkWarring(@PathVariable String id, @PathVariable Double lat, @PathVariable Double lon) { diff --git a/src/main/java/com/palnet/biz/api/main/dash/controller/MainDashController.java b/src/main/java/com/palnet/biz/api/main/dash/controller/MainDashController.java index dca97cc..de2e6a0 100644 --- a/src/main/java/com/palnet/biz/api/main/dash/controller/MainDashController.java +++ b/src/main/java/com/palnet/biz/api/main/dash/controller/MainDashController.java @@ -3,6 +3,7 @@ package com.palnet.biz.api.main.dash.controller; import java.util.List; import java.util.Map; +import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.v3.oas.annotations.tags.Tag; @@ -37,7 +38,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/main/dash", produces = {MediaType.APPLICATION_JSON_VALUE}) -@Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") +@Api(value = "MainDashController", tags = {"Main page API"}) public class MainDashController { @Autowired @@ -48,9 +49,8 @@ public class MainDashController { * @return */ @GetMapping(value = "/stcs/day") - @ApiOperation(value = "일 별 비행횟수 통계") - @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") - @ApiImplicitParam(name = "yyyymm",value = "날짜", dataTypeClass = String.class) + @ApiOperation(value = "Daily Flight Count Statistics") + @ApiImplicitParam(name = "yyyymm",value = "day", dataTypeClass = String.class) public ResponseEntity stcsDay(String yyyymm) { List result = null; @@ -83,9 +83,8 @@ public class MainDashController { * @return */ @GetMapping(value = "/stcs/area") - @ApiOperation(value = "TOP5 지역 별 비행횟수 통계") - @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") - @ApiImplicitParam(name = "yyyymm",value = "날짜", dataTypeClass = String.class) + @ApiOperation(value = "TOP5 Flight Count Stat") + @ApiImplicitParam(name = "yyyymm",value = "day", dataTypeClass = String.class) public ResponseEntity stcsArea(String yyyymm) { List result = null; @@ -115,9 +114,8 @@ public class MainDashController { * @return */ @GetMapping(value = "/group/list") - @ApiOperation(value = "본인이 생성한 그룹 정보") - @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Group Info have User Created") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity groupList(Integer cstmrSno) { List result = null; @@ -142,9 +140,8 @@ public class MainDashController { @GetMapping(value = "/arcrft/list") - @ApiOperation(value = "기체 정보 리스트") - @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") - @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호", dataTypeClass = Integer.class) + @ApiOperation(value = "Arcrft List") + @ApiImplicitParam(name = "cstmrSno",value = "cstmrSno", dataTypeClass = Integer.class) public ResponseEntity arcrftList(Integer cstmrSno) { List result = null; diff --git a/src/main/java/com/palnet/biz/config/SwaggerConfig.java b/src/main/java/com/palnet/biz/config/SwaggerConfig.java index 6a77d90..dae360a 100644 --- a/src/main/java/com/palnet/biz/config/SwaggerConfig.java +++ b/src/main/java/com/palnet/biz/config/SwaggerConfig.java @@ -3,6 +3,7 @@ package com.palnet.biz.config; import io.swagger.v3.oas.models.parameters.Parameter; 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; @@ -23,6 +24,7 @@ import java.util.List; @Configuration //@EnableSwagger2 +@EnableWebMvc public class SwaggerConfig {