From 889768101bc900db5c735b3bb958c156c311cd60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?hagjoon=28=EC=9D=B4=ED=95=99=EC=A4=80=29?= Date: Thu, 6 Oct 2022 17:49:42 +0900 Subject: [PATCH] =?UTF-8?q?Swagger=20-=20=EC=84=B8=EB=B6=80=EC=84=A4?= =?UTF-8?q?=EB=AA=85=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../bas/group/controller/BasGroupAprvController.java | 3 +++ .../api/bas/group/controller/BasGroupController.java | 10 ++++++++++ .../bas/group/controller/BasGroupJoinController.java | 4 ++++ .../bas/group/controller/BasGroupUserController.java | 4 ++++ .../api/ctr/cntrl/controller/CtrCntrlController.java | 11 +++++++++++ 5 files changed, 32 insertions(+) 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 14ed6f5..7c26845 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.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -41,6 +42,7 @@ public class BasGroupAprvController { * @return */ @GetMapping(value = "/list") + @ApiOperation(value = "승인요청 조회") public ResponseEntity list(BasGroupAprvRqModel rq) { List result = null; log.debug(">>>>" + rq.toString()); @@ -70,6 +72,7 @@ public class BasGroupAprvController { * @return */ @PutMapping(value = "/update") + @ApiOperation(value = "승인처리 / 승인취소 처리") 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 c150ae8..2c1fe08 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.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -41,6 +42,7 @@ public class BasGroupController { private final BasGroupService service; @GetMapping(value = "/createid") + @ApiOperation(value = "그룹코드 생성") public ResponseEntity createid() { Map resultMap = new HashMap(); @@ -65,6 +67,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/mylist") + @ApiOperation(value = "나의 그룹 목록 조회") public ResponseEntity mylist(Integer cstmrSno) { List result = null; @@ -96,6 +99,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/joinlist") + @ApiOperation(value = "나의 그룹 - 참여 그룹 목록 조회") public ResponseEntity joinList(Integer cstmrSno) { List result = null; @@ -126,6 +130,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/grouplist") + @ApiOperation(value = "그룹 목록 조회") public ResponseEntity grouplist(Integer cstmrSno) { List result = null; @@ -156,6 +161,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/list") + @ApiOperation(value = "전체 그룹 목록 조회") public ResponseEntity list(BasGroupRqModel rq) { List result = null; @@ -179,6 +185,7 @@ public class BasGroupController { * @return */ @GetMapping(value = "/detail/{id}") + @ApiOperation(value = "그룹 상세 조회") public ResponseEntity detail(@PathVariable String id) { BasGroupModel result = null; @@ -202,6 +209,7 @@ public class BasGroupController { * @throws Exception */ @PostMapping(value = "/create") + @ApiOperation(value = "그룹 생성") public ResponseEntity create(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -227,6 +235,7 @@ public class BasGroupController { * @throws Exception */ @PutMapping(value = "/update") + @ApiOperation(value = "그룹 수정") public ResponseEntity update(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -258,6 +267,7 @@ public class BasGroupController { * @return */ @DeleteMapping(value = "/delete/{id}") + @ApiOperation(value = "그룹 삭제") 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 a90ee4a..af6ed65 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.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -38,6 +39,7 @@ public class BasGroupJoinController { @GetMapping(value = "/list") + @ApiOperation(value = "참여한 그룹 목록 조회") public ResponseEntity list(BasGroupJoinRqModel rq) { List result = null; @@ -62,6 +64,7 @@ public class BasGroupJoinController { @PostMapping(value = "/create") + @ApiOperation(value = "그룹 가입 요청") public ResponseEntity create(@RequestBody BasGroupJoinModel rq) { Map resultMap = new HashMap(); @@ -81,6 +84,7 @@ public class BasGroupJoinController { } @PutMapping(value = "/update") + @ApiOperation(value = "그룹 가입 승인/미승인") 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 9b30357..c74f8ea 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.ApiOperation; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -48,6 +49,7 @@ public class BasGroupUserController { @GetMapping(value = "/list") + @ApiOperation(value = "그룹 사용자 조회") public ResponseEntity list(BasGroupUserListModel rq) { List result = null; @@ -72,6 +74,7 @@ public class BasGroupUserController { @PutMapping(value = "/update") + @ApiOperation(value = "그룹 사용자 권한 수정") public ResponseEntity update(@RequestBody BasGroupUserModel rq) { Map resultMap = new HashMap(); @@ -91,6 +94,7 @@ public class BasGroupUserController { } @PutMapping(value = "/delegate") + @ApiOperation(value = "MASTER 권한 위임") 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 b82d8de..a56af0b 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 @@ -5,6 +5,7 @@ import java.util.List; import java.util.Map; import com.palnet.biz.api.ctr.cntrl.model.*; +import io.swagger.annotations.ApiOperation; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -38,6 +39,7 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/history/{id}") + @ApiOperation(value = "TODO 드론 관제 이력 목록 (Socket 분리 전)") public ResponseEntity historyList(@PathVariable String id) { List result = null; @@ -60,6 +62,7 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/detail/{id}") + @ApiOperation(value = "TODO 드론 관제 상세 정보") public ResponseEntity detail(@PathVariable String id) { CtrCntrlDtlModel result = null; @@ -82,6 +85,7 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/history/list/{id}") + @ApiOperation(value = "TODO 드론 관제 '실시간' 이력 목록") public ResponseEntity history(@PathVariable String id) { List history; @@ -102,6 +106,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/group") + @ApiOperation(value = "TODO 비행 관제 사용자 권한 정보") public ResponseEntity findGroupAuthInfo(@RequestParam Integer cstmrSno) { List list; @@ -123,6 +128,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/flight_plan/{idntfNum}") + @ApiOperation(value = "TODO 비행 관제 사용자 비행 계획서 정보") public ResponseEntity findFlightPlan(@PathVariable("idntfNum") String idntfNum) { List list; @@ -144,6 +150,7 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/warn/detail/{id}") + @ApiOperation(value = "TODO 드론 운행 시작 후 알람 목록") public ResponseEntity warnDetail(@PathVariable String id){ List warnLog; @@ -164,6 +171,7 @@ public class CtrCntrlController { * @return */ @GetMapping(value = "/arcrft/warn/list") + @ApiOperation(value = "TODO 기체 별 최신 비정상 로그 및 비정상 로그 전체 개수") public ResponseEntity arcrftWarnList(@RequestParam("id") String id){ List arcrftWarnList; Map result = new HashMap<>(); @@ -185,6 +193,7 @@ public class CtrCntrlController { * @return */ @PostMapping("/contains") + @ApiOperation(value = "TODO 비행 관제 구역 비정상 상황 체크") public ResponseEntity checkPlanContains(@RequestBody CtrCntrlPlanContainsRq rq) { CtrCntrlPlanContainsRs rs; @@ -206,6 +215,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/id/{id}") + @ApiOperation(value = "TODO 실시간 Control ID 발급") public ResponseEntity getId(@PathVariable String id) { Map result; try { @@ -227,6 +237,7 @@ public class CtrCntrlController { * @return */ @GetMapping("/warn/{id}/{lat}/{lon}") + @ApiOperation(value = "TODO 비행 관제 기체의 비정상 상황 확인") public ResponseEntity checkWarring(@PathVariable String id, @PathVariable Double lat, @PathVariable Double lon) {