Swagger - 세부설명 작성

src/main/java/com/palnet/biz/api/bas/dron/controller/BasDronController.java

@@ -6,6 +6,7 @@ import java.util.List;
 import java.util.Map;
 
 import com.palnet.comn.utils.EncryptUtils;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -52,6 +53,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@GetMapping(value = "/list")
+	@ApiOperation(value = "드론 목록 조회")
 	public ResponseEntity<? extends BasicResponse> list(BasDronRqModel rq) {
 		List<BasDronModel> result = null;
 		
@@ -82,6 +84,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@GetMapping(value = "/idntf/list/{id}")
+	@ApiOperation(value = "식별정보 조회")
 	public ResponseEntity<? extends BasicResponse> mylist(@PathVariable Integer id) {
 		List<BasIdntfModel> result = null;
 		
@@ -112,6 +115,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@GetMapping(value = "/detail/{id}")
+	@ApiOperation(value = "드론 상세 조회")
 	public ResponseEntity<? extends BasicResponse> detail(@PathVariable Integer id) {
 		BasDronModel result = null;
 		
@@ -141,6 +145,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@PostMapping(value = "/create")
+	@ApiOperation(value = "드론정보 생성")
 	public ResponseEntity<? extends BasicResponse> create(@RequestBody BasDronModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -169,6 +174,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@PostMapping(value = "/idntf/create")
+	@ApiOperation(value = "식별장치 생성")
 	public ResponseEntity<? extends BasicResponse> createIdntf(@RequestBody BasIdntfRqModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -199,6 +205,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@PutMapping(value = "/update")
+	@ApiOperation(value = "드론정보 수정")
 	public ResponseEntity<? extends BasicResponse> update(@RequestBody BasDronModel rq) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -229,6 +236,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@DeleteMapping(value = "/delete/{id}")
+	@ApiOperation(value = "드론정보 삭제")
 	public ResponseEntity<? extends BasicResponse> delete(@PathVariable Integer id) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		
@@ -260,6 +268,7 @@ public class BasDronController {
 	 * @return
 	 */
 	@DeleteMapping(value = "/idntf/delete/{id}")
+	@ApiOperation(value = "식별장치 삭제")
 	public ResponseEntity<? extends BasicResponse> deleteIdntf(@PathVariable String id) {
 		Map<String , Object> resultMap = new HashMap<String,Object>();
 		

src/main/java/com/palnet/biz/api/bas/flight/controller/BasFlightController.java

@@ -7,6 +7,7 @@ import com.palnet.biz.api.comn.response.ErrorResponse;
 import com.palnet.biz.api.comn.response.SuccessResponse;
 import com.palnet.comn.code.RSErrorCode;
 import com.palnet.comn.exception.CustomException;
+import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.json.simple.JSONObject;
@@ -67,6 +68,7 @@ public class BasFlightController {
 
     // 비행계획서 조회
     @GetMapping(value = "/plan/list")
+    @ApiOperation(value = "비행계획서 조회")
     public ResponseEntity<? extends BasicResponse> findPlanList(BasFlightPlanListRq rq) {
         List<BasFlightPlanModel> result = null;
         // System.out.println(rq);
@@ -83,6 +85,7 @@ public class BasFlightController {
 
     // 비행계획서 상세 조회
     @GetMapping(value = "/plan/detail/{planSno}")
+    @ApiOperation(value = "비행계획서 상세 조회")
     public ResponseEntity<? extends BasicResponse> detailPlan(@PathVariable("planSno") Integer planSno) {
         BasFlightPlanModel result = null;
         try {
@@ -98,6 +101,7 @@ public class BasFlightController {
 
     // 비행계획서 등록
     @PostMapping(value = "/plan/create")
+    @ApiOperation(value = "비행계획서 등록")
     public ResponseEntity<? extends BasicResponse> createPlan(@RequestBody BasFlightPlanModel rq) {
         Map<String, Object> resultMap = new HashMap<String, Object>();
         try {
@@ -123,6 +127,7 @@ public class BasFlightController {
 
     // 비행계획서 수정
     @PutMapping(value = "/plan/update")
+    @ApiOperation(value = "비행계획서 수정")
     public ResponseEntity<? extends BasicResponse> updatePlan(@RequestBody BasFlightPlanModel rq) {
         Map<String, Object> resultMap = new HashMap<String, Object>();
         try {
@@ -146,6 +151,7 @@ public class BasFlightController {
 
     // 비행계획서 삭제
     @DeleteMapping(value = "/plan/delete/{planSno}")
+    @ApiOperation(value = "비행계획서 삭제")
     public ResponseEntity<? extends BasicResponse> deletePlan(@PathVariable("planSno") Integer planSno) {
         Map<String, Object> resultMap = new HashMap<String, Object>();
         try {
@@ -168,6 +174,7 @@ public class BasFlightController {
 
     // 그룹 조종사 조회
     @GetMapping(value = "/plan/pilot/{groupId}")
+    @ApiOperation(value = "그룹의 조종사 조회")
     public ResponseEntity<? extends BasicResponse> findPilot(@PathVariable("groupId") String groupId) {
         List<BasFlightPlanPilotModel> result = null;
         try {
@@ -184,6 +191,7 @@ public class BasFlightController {
     }
     // 그룹 기체 조회
     @GetMapping(value = "/plan/arcrft/{groupId}")
+    @ApiOperation(value = "그룹의 기체 조회")
     public ResponseEntity<? extends BasicResponse> findArcrft(@PathVariable("groupId") String groupId) {
         List<BasFlightPlanArcrftModel> result = null;
         try {
@@ -200,6 +208,7 @@ public class BasFlightController {
 
     // 비행 구역 버퍼 존 생성
     @PostMapping("/plan/area/buffer")
+    @ApiOperation(value = "비행 구역 버퍼 존 생성")
     public ResponseEntity<? extends BasicResponse> findBuffer(@RequestBody List<BasFlightPlanAreaModel> rq) {
         List<BasFlightPlanAreaModel> rs = null;
         try {
@@ -216,6 +225,7 @@ public class BasFlightController {
 
     // 비행계획서 리스트(승인)
     @GetMapping(value = "/aprv/list")
+    @ApiOperation(value = "비행계획서 리스트(승인)")
     public ResponseEntity<? extends BasicResponse> findAprvList(BasFlightPlanListRq rq) {
         List<BasFlightPlanModel> result = null;
         try {
@@ -230,6 +240,7 @@ public class BasFlightController {
     }
     // 비행계획서 승인/미승인
     @PutMapping(value = "/aprv/proc")
+    @ApiOperation(value = "비행 계획서 승인/미승인")
     public ResponseEntity<? extends BasicResponse> updateAprvProc(@RequestBody BasFlightAprovRq rq) {
         Map<String, Object> resultMap = new HashMap<String, Object>();
         try {
@@ -270,6 +281,7 @@ public class BasFlightController {
     
     //지역 검색
     @GetMapping("/plan/area/search")
+    @ApiOperation(value = "지역 검색")
     public ResponseEntity<? extends BasicResponse> searchArea(String query) throws ParseException {
     	String text = null;
     	try {

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.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -44,6 +45,7 @@ public class MainDashController {
 	 * @return
 	 */
 	@GetMapping(value = "/stcs/day")
+	@ApiOperation(value = "일 별 비행횟수 통계")
 	public ResponseEntity<? extends BasicResponse> stcsDay(String yyyymm) {
 		List<MainDashStcsModel> result = null;
 		
@@ -76,6 +78,7 @@ public class MainDashController {
 	 * @return
 	 */
 	@GetMapping(value = "/stcs/area")
+	@ApiOperation(value = "TOP5 지역 별 비행횟수 통계")
 	public ResponseEntity<? extends BasicResponse> stcsArea(String yyyymm) {
 		List<MainDashStcsModel> result = null;
 		
@@ -105,6 +108,7 @@ public class MainDashController {
 	 * @return
 	 */
 	@GetMapping(value = "/group/list")
+	@ApiOperation(value = "본인이 생성한 그룹 정보")
 	public ResponseEntity<? extends BasicResponse> groupList(Integer cstmrSno) {
 		List<Map> result = null;
 		
@@ -129,6 +133,7 @@ public class MainDashController {
 	
 	
 	@GetMapping(value = "/arcrft/list")
+	@ApiOperation(value = "기체 정보 리스트")
 	public ResponseEntity<? extends BasicResponse> arcrftList(Integer cstmrSno) {
 		List<MainDashListModel> result = null;