From ef2dc21467c11e6b427f48da0a9bb299aa1da2f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?hagjoon=28=EC=9D=B4=ED=95=99=EC=A4=80=29?= Date: Fri, 7 Oct 2022 12:03:22 +0900 Subject: [PATCH] =?UTF-8?q?Swagger=20-=20param=20=EC=84=B8=EB=B6=80?= =?UTF-8?q?=EC=84=A4=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 --- .../hstry/controller/AnlsHstryController.java | 8 +++++++ .../smlt/controller/AnlsSmltController.java | 11 ++++++++++ .../dron/controller/BasDronController.java | 16 ++++++++++++++ .../controller/BasFlightController.java | 21 +++++++++++++++++++ .../controller/BasGroupAprvController.java | 4 ++++ .../group/controller/BasGroupController.java | 17 +++++++++++++++ .../controller/BasGroupJoinController.java | 5 +++++ .../controller/BasGroupUserController.java | 5 +++++ .../cntrl/controller/CtrCntrlController.java | 19 +++++++++++++++++ .../dash/controller/MainDashController.java | 11 ++++++++++ 10 files changed, 117 insertions(+) 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 1d1c744..3f506d3 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,7 +3,9 @@ package com.palnet.biz.api.anls.hstry.controller; import java.util.List; import com.palnet.biz.api.comn.model.ComnPagingRs; +import io.swagger.annotations.ApiImplicitParam; 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; @@ -32,6 +34,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/anls/hstry", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") public class AnlsHstryController { @Autowired @@ -40,6 +43,7 @@ public class AnlsHstryController { @GetMapping(value = "/list") @ApiOperation(value = "비행 현황 목록 출력") + @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") public ResponseEntity list(AnlsHstryGroupModel rq) { List rs = null; ComnPagingRs response; @@ -65,6 +69,8 @@ public class AnlsHstryController { @GetMapping(value = "/detail/{id}") @ApiOperation(value = "비행 현황 상세") + @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity detail(@PathVariable String id) { AnlsHstryModel result = null; @@ -84,6 +90,8 @@ public class AnlsHstryController { @GetMapping(value = "/log/{id}") @ApiOperation(value = "비행 이력 데이터") + @Tag(name = "비행 이력 현황", description = "비행 이력 현황 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") 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 6929a7c..11bd3c8 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,7 +2,10 @@ package com.palnet.biz.api.anls.smlt.controller; import java.util.List; +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.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -31,6 +34,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/anls/smlt", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") public class AnlsSmltController { @Autowired @@ -43,6 +47,7 @@ public class AnlsSmltController { */ @GetMapping(value = "/list") @ApiOperation(value = "비행 현황 목록") + @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") public ResponseEntity list(AnlsHstryRqModel rq) { List result = null; @@ -77,6 +82,8 @@ public class AnlsSmltController { */ @GetMapping(value = "/hist/{id}") @ApiOperation(value = "비행 이력 데이터 조회") + @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity histList(@PathVariable String id) { List result = null; @@ -102,6 +109,8 @@ public class AnlsSmltController { */ @GetMapping(value = "/stcs/{id}") @ApiOperation(value = "통계 데이터 조회") + @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity stcsList(@PathVariable String id) { List result = null; @@ -127,6 +136,8 @@ public class AnlsSmltController { */ @GetMapping(value = "/detail/{id}") @ApiOperation(value = "비행 상세정보 조회") + @Tag(name = "비행 시뮬레이션", description = "비행 이력 시뮬레이션 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") 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 329a4d3..7d95c68 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 @@ -6,7 +6,10 @@ import java.util.List; import java.util.Map; import com.palnet.comn.utils.EncryptUtils; +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.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; @@ -41,6 +44,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/dron", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "드론 컨트롤러", description = "드론 관련 API") public class BasDronController { @Autowired @@ -54,6 +58,7 @@ public class BasDronController { */ @GetMapping(value = "/list") @ApiOperation(value = "드론 목록 조회") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") public ResponseEntity list(BasDronRqModel rq) { List result = null; @@ -85,6 +90,8 @@ public class BasDronController { */ @GetMapping(value = "/idntf/list/{id}") @ApiOperation(value = "식별정보 조회") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiImplicitParam(name = "id",value = "기체일련번호") public ResponseEntity mylist(@PathVariable Integer id) { List result = null; @@ -116,6 +123,8 @@ public class BasDronController { */ @GetMapping(value = "/detail/{id}") @ApiOperation(value = "드론 상세 조회") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiImplicitParam(name = "id",value = "기체일련번호") public ResponseEntity detail(@PathVariable Integer id) { BasDronModel result = null; @@ -146,6 +155,7 @@ public class BasDronController { */ @PostMapping(value = "/create") @ApiOperation(value = "드론정보 생성") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") public ResponseEntity create(@RequestBody BasDronModel rq) { Map resultMap = new HashMap(); @@ -175,6 +185,7 @@ public class BasDronController { */ @PostMapping(value = "/idntf/create") @ApiOperation(value = "식별장치 생성") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") public ResponseEntity createIdntf(@RequestBody BasIdntfRqModel rq) { Map resultMap = new HashMap(); @@ -206,6 +217,7 @@ public class BasDronController { */ @PutMapping(value = "/update") @ApiOperation(value = "드론정보 수정") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") public ResponseEntity update(@RequestBody BasDronModel rq) { Map resultMap = new HashMap(); @@ -237,6 +249,8 @@ public class BasDronController { */ @DeleteMapping(value = "/delete/{id}") @ApiOperation(value = "드론정보 삭제") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiImplicitParam(name = "id",value = "기체일련번호") public ResponseEntity delete(@PathVariable Integer id) { Map resultMap = new HashMap(); @@ -269,6 +283,8 @@ public class BasDronController { */ @DeleteMapping(value = "/idntf/delete/{id}") @ApiOperation(value = "식별장치 삭제") + @Tag(name = "드론 컨트롤러", description = "드론 관련 API") + @ApiImplicitParam(name = "id",value = "식별번호") 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 84795ef..7bda5fb 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 @@ -7,7 +7,9 @@ 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.ApiImplicitParam; import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.json.simple.JSONObject; @@ -33,6 +35,7 @@ import java.util.Map; @Slf4j @RestController @RequestMapping(value = "/api/bas/flight", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "비행계획서", description = "비행계획서 관련 API") public class BasFlightController { private final BasFlightService basFlightService; @@ -44,6 +47,7 @@ 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"); @@ -69,6 +73,7 @@ public class BasFlightController { // 비행계획서 조회 @GetMapping(value = "/plan/list") @ApiOperation(value = "비행계획서 조회") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity findPlanList(BasFlightPlanListRq rq) { List result = null; // System.out.println(rq); @@ -86,6 +91,8 @@ public class BasFlightController { // 비행계획서 상세 조회 @GetMapping(value = "/plan/detail/{planSno}") @ApiOperation(value = "비행계획서 상세 조회") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiImplicitParam(name = "planSno",value = "비행계획서일련번호") public ResponseEntity detailPlan(@PathVariable("planSno") Integer planSno) { BasFlightPlanModel result = null; try { @@ -102,6 +109,7 @@ public class BasFlightController { // 비행계획서 등록 @PostMapping(value = "/plan/create") @ApiOperation(value = "비행계획서 등록") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity createPlan(@RequestBody BasFlightPlanModel rq) { Map resultMap = new HashMap(); try { @@ -128,6 +136,7 @@ public class BasFlightController { // 비행계획서 수정 @PutMapping(value = "/plan/update") @ApiOperation(value = "비행계획서 수정") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity updatePlan(@RequestBody BasFlightPlanModel rq) { Map resultMap = new HashMap(); try { @@ -152,6 +161,8 @@ public class BasFlightController { // 비행계획서 삭제 @DeleteMapping(value = "/plan/delete/{planSno}") @ApiOperation(value = "비행계획서 삭제") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiImplicitParam(name = "planSno",value = "비행계획서일련번호") public ResponseEntity deletePlan(@PathVariable("planSno") Integer planSno) { Map resultMap = new HashMap(); try { @@ -175,6 +186,8 @@ public class BasFlightController { // 그룹 조종사 조회 @GetMapping(value = "/plan/pilot/{groupId}") @ApiOperation(value = "그룹의 조종사 조회") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiImplicitParam(name = "groupId",value = "그룹ID") public ResponseEntity findPilot(@PathVariable("groupId") String groupId) { List result = null; try { @@ -192,6 +205,8 @@ public class BasFlightController { // 그룹 기체 조회 @GetMapping(value = "/plan/arcrft/{groupId}") @ApiOperation(value = "그룹의 기체 조회") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") + @ApiImplicitParam(name = "groupId",value = "그룹ID") public ResponseEntity findArcrft(@PathVariable("groupId") String groupId) { List result = null; try { @@ -209,6 +224,7 @@ public class BasFlightController { // 비행 구역 버퍼 존 생성 @PostMapping("/plan/area/buffer") @ApiOperation(value = "비행 구역 버퍼 존 생성") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity findBuffer(@RequestBody List rq) { List rs = null; try { @@ -226,6 +242,7 @@ public class BasFlightController { // 비행계획서 리스트(승인) @GetMapping(value = "/aprv/list") @ApiOperation(value = "비행계획서 리스트(승인)") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity findAprvList(BasFlightPlanListRq rq) { List result = null; try { @@ -241,6 +258,7 @@ public class BasFlightController { // 비행계획서 승인/미승인 @PutMapping(value = "/aprv/proc") @ApiOperation(value = "비행 계획서 승인/미승인") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity updateAprvProc(@RequestBody BasFlightAprovRq rq) { Map resultMap = new HashMap(); try { @@ -263,6 +281,7 @@ public class BasFlightController { } @PostMapping("/airspace/contains") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity checkAirspaceContains(@RequestBody List rq) { Map resultMap = new HashMap(); try { @@ -282,6 +301,7 @@ public class BasFlightController { //지역 검색 @GetMapping("/plan/area/search") @ApiOperation(value = "지역 검색") + @Tag(name = "비행계획서", description = "비행계획서 관련 API") public ResponseEntity searchArea(String query) throws ParseException { String text = null; try { @@ -303,6 +323,7 @@ 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 81811de..42fd7ad 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 @@ -5,6 +5,7 @@ import java.util.List; import java.util.Map; 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; @@ -31,6 +32,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/aprv", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") public class BasGroupAprvController { @Autowired @@ -43,6 +45,7 @@ public class BasGroupAprvController { */ @GetMapping(value = "/list") @ApiOperation(value = "승인요청 조회") + @Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") public ResponseEntity list(BasGroupAprvRqModel rq) { List result = null; // log.debug(">>>>" + rq.toString()); @@ -73,6 +76,7 @@ public class BasGroupAprvController { */ @PutMapping(value = "/update") @ApiOperation(value = "승인처리 / 승인취소 처리") + @Tag(name = "그룹 승인 컨트롤러", description = "그룹 가입 승인 관련 API") 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 2c1fe08..9391e09 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,7 +4,9 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import io.swagger.annotations.ApiImplicitParam; 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; @@ -36,6 +38,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") public class BasGroupController { @Autowired @@ -43,6 +46,7 @@ public class BasGroupController { @GetMapping(value = "/createid") @ApiOperation(value = "그룹코드 생성") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") public ResponseEntity createid() { Map resultMap = new HashMap(); @@ -68,6 +72,8 @@ public class BasGroupController { */ @GetMapping(value = "/mylist") @ApiOperation(value = "나의 그룹 목록 조회") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity mylist(Integer cstmrSno) { List result = null; @@ -100,6 +106,8 @@ public class BasGroupController { */ @GetMapping(value = "/joinlist") @ApiOperation(value = "나의 그룹 - 참여 그룹 목록 조회") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity joinList(Integer cstmrSno) { List result = null; @@ -131,6 +139,8 @@ public class BasGroupController { */ @GetMapping(value = "/grouplist") @ApiOperation(value = "그룹 목록 조회") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity grouplist(Integer cstmrSno) { List result = null; @@ -162,6 +172,7 @@ public class BasGroupController { */ @GetMapping(value = "/list") @ApiOperation(value = "전체 그룹 목록 조회") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") public ResponseEntity list(BasGroupRqModel rq) { List result = null; @@ -186,6 +197,8 @@ public class BasGroupController { */ @GetMapping(value = "/detail/{id}") @ApiOperation(value = "그룹 상세 조회") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiImplicitParam(name = "id",value = "그룹ID") public ResponseEntity detail(@PathVariable String id) { BasGroupModel result = null; @@ -210,6 +223,7 @@ public class BasGroupController { */ @PostMapping(value = "/create") @ApiOperation(value = "그룹 생성") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") public ResponseEntity create(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -236,6 +250,7 @@ public class BasGroupController { */ @PutMapping(value = "/update") @ApiOperation(value = "그룹 수정") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") public ResponseEntity update(@RequestBody BasGroupModel rq) throws Exception { Map resultMap = new HashMap(); @@ -268,6 +283,8 @@ public class BasGroupController { */ @DeleteMapping(value = "/delete/{id}") @ApiOperation(value = "그룹 삭제") + @Tag(name = "그룹 컨트롤러", description = "그룹 관련 API") + @ApiImplicitParam(name = "id",value = "그룹ID") 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 af6ed65..102db38 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 @@ -5,6 +5,7 @@ import java.util.List; import java.util.Map; 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; @@ -32,6 +33,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/join", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") public class BasGroupJoinController { @Autowired @@ -40,6 +42,7 @@ public class BasGroupJoinController { @GetMapping(value = "/list") @ApiOperation(value = "참여한 그룹 목록 조회") + @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") public ResponseEntity list(BasGroupJoinRqModel rq) { List result = null; @@ -65,6 +68,7 @@ public class BasGroupJoinController { @PostMapping(value = "/create") @ApiOperation(value = "그룹 가입 요청") + @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") public ResponseEntity create(@RequestBody BasGroupJoinModel rq) { Map resultMap = new HashMap(); @@ -85,6 +89,7 @@ public class BasGroupJoinController { @PutMapping(value = "/update") @ApiOperation(value = "그룹 가입 승인/미승인") + @Tag(name = "그룹 참여 컨트롤러", description = "그룹 참여 관련 API") 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 c74f8ea..4a68faf 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 @@ -5,6 +5,7 @@ import java.util.List; import java.util.Map; 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; @@ -42,6 +43,7 @@ import lombok.extern.log4j.Log4j2; @RestController @RequiredArgsConstructor @RequestMapping(value = "/api/bas/group/user", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") public class BasGroupUserController { @Autowired @@ -50,6 +52,7 @@ public class BasGroupUserController { @GetMapping(value = "/list") @ApiOperation(value = "그룹 사용자 조회") + @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") public ResponseEntity list(BasGroupUserListModel rq) { List result = null; @@ -75,6 +78,7 @@ public class BasGroupUserController { @PutMapping(value = "/update") @ApiOperation(value = "그룹 사용자 권한 수정") + @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") public ResponseEntity update(@RequestBody BasGroupUserModel rq) { Map resultMap = new HashMap(); @@ -95,6 +99,7 @@ public class BasGroupUserController { @PutMapping(value = "/delegate") @ApiOperation(value = "MASTER 권한 위임") + @Tag(name = "그룹 사용자 컨트롤러", description = "그룹 사용자 관련 API") 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 a56af0b..a352d94 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,7 +5,9 @@ import java.util.List; import java.util.Map; import com.palnet.biz.api.ctr.cntrl.model.*; +import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -24,6 +26,7 @@ import lombok.extern.log4j.Log4j2; @Log4j2 @RestController @RequestMapping(value = "/api/ctr/cntrl", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") public class CtrCntrlController { private final CtrCntrlService service; @@ -40,6 +43,8 @@ public class CtrCntrlController { */ @GetMapping(value = "/history/{id}") @ApiOperation(value = "TODO 드론 관제 이력 목록 (Socket 분리 전)") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity historyList(@PathVariable String id) { List result = null; @@ -63,6 +68,8 @@ public class CtrCntrlController { */ @GetMapping(value = "/detail/{id}") @ApiOperation(value = "TODO 드론 관제 상세 정보") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity detail(@PathVariable String id) { CtrCntrlDtlModel result = null; @@ -86,6 +93,8 @@ public class CtrCntrlController { */ @GetMapping(value = "/history/list/{id}") @ApiOperation(value = "TODO 드론 관제 '실시간' 이력 목록") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity history(@PathVariable String id) { List history; @@ -107,6 +116,8 @@ public class CtrCntrlController { */ @GetMapping("/group") @ApiOperation(value = "TODO 비행 관제 사용자 권한 정보") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity findGroupAuthInfo(@RequestParam Integer cstmrSno) { List list; @@ -129,6 +140,8 @@ public class CtrCntrlController { */ @GetMapping("/flight_plan/{idntfNum}") @ApiOperation(value = "TODO 비행 관제 사용자 비행 계획서 정보") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "idtfNum",value = "식별번호") public ResponseEntity findFlightPlan(@PathVariable("idntfNum") String idntfNum) { List list; @@ -151,6 +164,8 @@ public class CtrCntrlController { */ @GetMapping(value = "/warn/detail/{id}") @ApiOperation(value = "TODO 드론 운행 시작 후 알람 목록") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") + @ApiImplicitParam(name = "id",value = "관제ID") public ResponseEntity warnDetail(@PathVariable String id){ List warnLog; @@ -172,6 +187,7 @@ public class CtrCntrlController { */ @GetMapping(value = "/arcrft/warn/list") @ApiOperation(value = "TODO 기체 별 최신 비정상 로그 및 비정상 로그 전체 개수") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") public ResponseEntity arcrftWarnList(@RequestParam("id") String id){ List arcrftWarnList; Map result = new HashMap<>(); @@ -194,6 +210,7 @@ public class CtrCntrlController { */ @PostMapping("/contains") @ApiOperation(value = "TODO 비행 관제 구역 비정상 상황 체크") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") public ResponseEntity checkPlanContains(@RequestBody CtrCntrlPlanContainsRq rq) { CtrCntrlPlanContainsRs rs; @@ -216,6 +233,7 @@ public class CtrCntrlController { */ @GetMapping("/id/{id}") @ApiOperation(value = "TODO 실시간 Control ID 발급") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") public ResponseEntity getId(@PathVariable String id) { Map result; try { @@ -238,6 +256,7 @@ public class CtrCntrlController { */ @GetMapping("/warn/{id}/{lat}/{lon}") @ApiOperation(value = "TODO 비행 관제 기체의 비정상 상황 확인") + @Tag(name = "드론 관제 시스템", description = "드론 관제 관련 API") 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 409ff5a..7244eab 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,7 +3,9 @@ package com.palnet.biz.api.main.dash.controller; import java.util.List; import java.util.Map; +import io.swagger.annotations.ApiImplicitParam; 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/main/dash", produces = {MediaType.APPLICATION_JSON_VALUE}) +@Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") public class MainDashController { @Autowired @@ -46,6 +49,8 @@ public class MainDashController { */ @GetMapping(value = "/stcs/day") @ApiOperation(value = "일 별 비행횟수 통계") + @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") + @ApiImplicitParam(name = "yyyymm",value = "날짜") public ResponseEntity stcsDay(String yyyymm) { List result = null; @@ -79,6 +84,8 @@ public class MainDashController { */ @GetMapping(value = "/stcs/area") @ApiOperation(value = "TOP5 지역 별 비행횟수 통계") + @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") + @ApiImplicitParam(name = "yyyymm",value = "날짜") public ResponseEntity stcsArea(String yyyymm) { List result = null; @@ -109,6 +116,8 @@ public class MainDashController { */ @GetMapping(value = "/group/list") @ApiOperation(value = "본인이 생성한 그룹 정보") + @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity groupList(Integer cstmrSno) { List result = null; @@ -134,6 +143,8 @@ public class MainDashController { @GetMapping(value = "/arcrft/list") @ApiOperation(value = "기체 정보 리스트") + @Tag(name = "메인화면 컨트롤러", description = "메인화면 관련 API") + @ApiImplicitParam(name = "cstmrSno",value = "고객일련번호") public ResponseEntity arcrftList(Integer cstmrSno) { List result = null;