Swagger - 세부설명 작성

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<? extends BasicResponse> list(BasGroupAprvRqModel rq) {
 		List<BasGroupAprvModel> result = null;
 		log.debug(">>>>" + rq.toString());
@@ -70,6 +72,7 @@ public class BasGroupAprvController {
 	 * @return
 	 */
 	@PutMapping(value = "/update")
+	@ApiOperation(value = "승인처리 / 승인취소 처리")
 	public ResponseEntity<? extends BasicResponse> update(@RequestBody BasGroupAprvModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		

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<? extends BasicResponse> createid() {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -65,6 +67,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@GetMapping(value = "/mylist")
+	@ApiOperation(value = "나의 그룹 목록 조회")
 	public ResponseEntity<? extends BasicResponse> mylist(Integer cstmrSno) {
 		List<BasGroupModel> result = null;
 		
@@ -96,6 +99,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@GetMapping(value = "/joinlist")
+	@ApiOperation(value = "나의 그룹 - 참여 그룹 목록 조회")
 	public ResponseEntity<? extends BasicResponse> joinList(Integer cstmrSno) {
 		List<BasGroupJoinModel> result = null;
 		
@@ -126,6 +130,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@GetMapping(value = "/grouplist")
+	@ApiOperation(value = "그룹 목록 조회")
 	public ResponseEntity<? extends BasicResponse> grouplist(Integer cstmrSno) {
 		List<BasGroupJoinModel> result = null;
 		
@@ -156,6 +161,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@GetMapping(value = "/list")
+	@ApiOperation(value = "전체 그룹 목록 조회")
 	public ResponseEntity<? extends BasicResponse> list(BasGroupRqModel rq) {
 		List<BasGroupModel> result = null;
 		
@@ -179,6 +185,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@GetMapping(value = "/detail/{id}")
+	@ApiOperation(value = "그룹 상세 조회")
 	public ResponseEntity<? extends BasicResponse> detail(@PathVariable String id) {
 		BasGroupModel result = null;
 		
@@ -202,6 +209,7 @@ public class BasGroupController {
 	 * @throws Exception 
 	 */
 	@PostMapping(value = "/create")
+	@ApiOperation(value = "그룹 생성")
 	public ResponseEntity<? extends BasicResponse> create(@RequestBody BasGroupModel rq) throws Exception {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -227,6 +235,7 @@ public class BasGroupController {
 	 * @throws Exception 
 	 */
 	@PutMapping(value = "/update")
+	@ApiOperation(value = "그룹 수정")
 	public ResponseEntity<? extends BasicResponse> update(@RequestBody BasGroupModel rq) throws Exception {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -258,6 +267,7 @@ public class BasGroupController {
 	 * @return
 	 */
 	@DeleteMapping(value = "/delete/{id}")
+	@ApiOperation(value = "그룹 삭제")
 	public ResponseEntity<? extends BasicResponse> delete(@PathVariable String id) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		

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<? extends BasicResponse> list(BasGroupJoinRqModel rq) {
 		List<BasGroupJoinModel> result = null;
 		
@@ -62,6 +64,7 @@ public class BasGroupJoinController {
 	
 	
 	@PostMapping(value = "/create")
+	@ApiOperation(value = "그룹 가입 요청")
 	public ResponseEntity<? extends BasicResponse> create(@RequestBody BasGroupJoinModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -81,6 +84,7 @@ public class BasGroupJoinController {
 	}
 	
 	@PutMapping(value = "/update")
+	@ApiOperation(value = "그룹 가입 승인/미승인")
 	public ResponseEntity<? extends BasicResponse> update(@RequestBody BasGroupJoinModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 

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<? extends BasicResponse> list(BasGroupUserListModel rq) {
 		List<BasGroupUserModel> result = null;
 		
@@ -72,6 +74,7 @@ public class BasGroupUserController {
 	
 	
 	@PutMapping(value = "/update")
+	@ApiOperation(value = "그룹 사용자 권한 수정")
 	public ResponseEntity<? extends BasicResponse> update(@RequestBody BasGroupUserModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 
@@ -91,6 +94,7 @@ public class BasGroupUserController {
 	}
 	
 	@PutMapping(value = "/delegate")
+	@ApiOperation(value = "MASTER 권한 위임")
 	public ResponseEntity<? extends BasicResponse> delegate(@RequestBody List<BasGroupUserModel> rq) {
 		Map<String, Object> resultMap = new HashMap<String, Object>();
 		

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<? extends BasicResponse> historyList(@PathVariable String id) {
 		List<GPHistoryModel> result = null;
 
@@ -60,6 +62,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping(value = "/detail/{id}")
+	@ApiOperation(value = "TODO 드론 관제 상세 정보")
 	public ResponseEntity<? extends BasicResponse> 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<? extends BasicResponse> history(@PathVariable String id) {
 		List<GPHistoryModel> history;
 
@@ -102,6 +106,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping("/group")
+	@ApiOperation(value = "TODO 비행 관제 사용자 권한 정보")
 	public ResponseEntity<? extends BasicResponse> findGroupAuthInfo(@RequestParam Integer cstmrSno) {
 		List<CtrCntrlGroupModel> list;
 
@@ -123,6 +128,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping("/flight_plan/{idntfNum}")
+	@ApiOperation(value = "TODO 비행 관제 사용자 비행 계획서 정보")
 	public ResponseEntity<? extends BasicResponse> findFlightPlan(@PathVariable("idntfNum") String idntfNum) {
 		List<BasFlightPlanModel> list;
 
@@ -144,6 +150,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping(value = "/warn/detail/{id}")
+	@ApiOperation(value = "TODO 드론 운행 시작 후 알람 목록")
 	public ResponseEntity<? extends BasicResponse> warnDetail(@PathVariable String id){
 		List<CtrCntrlWarnLogModel> warnLog;
 		
@@ -164,6 +171,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping(value = "/arcrft/warn/list")
+	@ApiOperation(value = "TODO 기체 별 최신 비정상 로그 및 비정상 로그 전체 개수")
 	public ResponseEntity<? extends BasicResponse> arcrftWarnList(@RequestParam("id") String id){
 		List<CtrCntrlArcrftWarnModel> arcrftWarnList;
 		Map<String, CtrCntrlArcrftWarnModel> result = new HashMap<>();
@@ -185,6 +193,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@PostMapping("/contains")
+	@ApiOperation(value = "TODO 비행 관제 구역 비정상 상황 체크")
 	public ResponseEntity<? extends BasicResponse> checkPlanContains(@RequestBody CtrCntrlPlanContainsRq rq) {
 		CtrCntrlPlanContainsRs rs;
 
@@ -206,6 +215,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping("/id/{id}")
+	@ApiOperation(value = "TODO 실시간 Control ID 발급")
 	public ResponseEntity<? extends BasicResponse> getId(@PathVariable String id) {
 		Map<String, String> result;
 		try {
@@ -227,6 +237,7 @@ public class CtrCntrlController {
 	 * @return
 	 */
 	@GetMapping("/warn/{id}/{lat}/{lon}")
+	@ApiOperation(value = "TODO 비행 관제 기체의 비정상 상황 확인")
 	public ResponseEntity<? extends BasicResponse> checkWarring(@PathVariable String id,
 																@PathVariable Double lat,
 																@PathVariable Double lon) {