From 51516b8d0b7b51c8c046c209f1439fc914261cc5 Mon Sep 17 00:00:00 2001 From: changkyu choi Date: Tue, 24 Dec 2024 10:47:02 +0900 Subject: [PATCH] =?UTF-8?q?api=20description=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../qcast/biz/master/MasterController.java | 68 +++++++++---------- .../master/dto/ApiConstructionRequest.java | 30 ++++---- .../master/dto/ApiConstructionResponse.java | 20 +++--- .../biz/master/dto/ApiModuleTpRequest.java | 6 +- .../qcast/biz/master/dto/ApiResponse.java | 15 +++- .../dto/ApiTrestleDetailModuleResponse.java | 18 ++--- .../dto/ApiTrestleDetailRackResponse.java | 10 +-- .../master/dto/ApiTrestleDetailRequest.java | 34 +++++----- .../master/dto/ApiTrestleDetailResponse.java | 38 +++++------ .../biz/master/dto/ApiTrestleRequest.java | 18 ++--- .../biz/master/dto/ApiTrestleResponse.java | 42 ++++++------ 11 files changed, 155 insertions(+), 144 deletions(-) diff --git a/src/main/java/com/interplug/qcast/biz/master/MasterController.java b/src/main/java/com/interplug/qcast/biz/master/MasterController.java index 045a58e3..09c30f13 100644 --- a/src/main/java/com/interplug/qcast/biz/master/MasterController.java +++ b/src/main/java/com/interplug/qcast/biz/master/MasterController.java @@ -46,34 +46,34 @@ public class MasterController { return masterService.getModuleTypeItemList(roofMaterialCd); } - @Operation(description = "가대 목록 조회") + @Operation(description = "가대 목록 조회한다.") @GetMapping("/getTrestleList") public ApiResponse getTrestleList( - @RequestParam(required = false) String moduleTpCd, - @RequestParam(required = false) String roofMatlCd, - @RequestParam(required = false) String raftBaseCd, - @RequestParam(required = false) String trestleMkrCd, - @RequestParam(required = false) String constMthdCd, - @RequestParam(required = false) String roofBaseCd) { + @Parameter(description = "모듈타입코드") @RequestParam(required = false) String moduleTpCd, + @Parameter(description = "지붕재코드") @RequestParam(required = false) String roofMatlCd, + @Parameter(description = "서까래기초코드") @RequestParam(required = false) String raftBaseCd, + @Parameter(description = "가대메이커코드") @RequestParam(required = false) String trestleMkrCd, + @Parameter(description = "공법코드") @RequestParam(required = false) String constMthdCd, + @Parameter(description = "지붕기초코드") @RequestParam(required = false) String roofBaseCd) { return masterService.getTrestleList(moduleTpCd,roofMatlCd,raftBaseCd,trestleMkrCd,constMthdCd,roofBaseCd); } - @Operation(description = "시공법 목록 조회") + @Operation(description = "시공법 목록 조회한다.") @GetMapping("/getConstructionList") public ApiResponse getConstructionList( - @RequestParam String moduleTpCd, - @RequestParam String roofMatlCd, - @RequestParam String trestleMkrCd, - @RequestParam String constMthdCd, - @RequestParam String roofBaseCd, - @RequestParam String illuminationTp, - @RequestParam String instHt, - @RequestParam String stdWindSpeed, - @RequestParam String stdSnowLd, - @RequestParam String inclCd, - @RequestParam(required = false) String raftBaseCd, - @RequestParam(required = false) Integer roofPitch) throws QcastException { + @Parameter(description = "모듈타입코드") @RequestParam String moduleTpCd, + @Parameter(description = "지붕재코드") @RequestParam String roofMatlCd, + @Parameter(description = "가대메이커코드") @RequestParam String trestleMkrCd, + @Parameter(description = "공법코드") @RequestParam String constMthdCd, + @Parameter(description = "지붕기초코드") @RequestParam String roofBaseCd, + @Parameter(description = "면조도") @RequestParam String illuminationTp, + @Parameter(description = "설치높이") @RequestParam String instHt, + @Parameter(description = "풍속") @RequestParam String stdWindSpeed, + @Parameter(description = "적설량") @RequestParam String stdSnowLd, + @Parameter(description = "경사도코드") @RequestParam String inclCd, + @Parameter(description = "서까래기초코드") @RequestParam(required = false) String raftBaseCd, + @Parameter(description = "하제(망둥어)피치") @RequestParam(required = false) Integer roofPitch) throws QcastException { if (moduleTpCd == null || moduleTpCd.trim().isEmpty() || roofMatlCd == null || roofMatlCd.trim().isEmpty() || @@ -90,22 +90,22 @@ public class MasterController { return masterService.getConstructionList(moduleTpCd, roofMatlCd, trestleMkrCd, constMthdCd, roofBaseCd, illuminationTp, instHt, stdWindSpeed, stdSnowLd, inclCd, raftBaseCd, roofPitch); } - @Operation(description = "가대 상세 조회") + @Operation(description = "가대 상세 조회한다.") @GetMapping("/getTrestleDetailList") public ApiResponse getTrestleDetailList( - @RequestParam String moduleTpCd, - @RequestParam String roofMatlCd, - @RequestParam String trestleMkrCd, - @RequestParam String constMthdCd, - @RequestParam String roofBaseCd, - @RequestParam String illuminationTp, - @RequestParam String instHt, - @RequestParam String stdWindSpeed, - @RequestParam String stdSnowLd, - @RequestParam String inclCd, - @RequestParam String constTp, - @RequestParam(required = false) Integer mixMatlNo, - @RequestParam(required = false) Integer roofPitch) throws QcastException { + @Parameter(description = "모듈타입코드") @RequestParam String moduleTpCd, + @Parameter(description = "지붕재코드") @RequestParam String roofMatlCd, + @Parameter(description = "가대메이커코드") @RequestParam String trestleMkrCd, + @Parameter(description = "공법코드") @RequestParam String constMthdCd, + @Parameter(description = "지붕기초코드") @RequestParam String roofBaseCd, + @Parameter(description = "면조도") @RequestParam String illuminationTp, + @Parameter(description = "설치높이") @RequestParam String instHt, + @Parameter(description = "풍속") @RequestParam String stdWindSpeed, + @Parameter(description = "적설량") @RequestParam String stdSnowLd, + @Parameter(description = "경사도코드") @RequestParam String inclCd, + @Parameter(description = "시공법") @RequestParam String constTp, + @Parameter(description = "혼합모듈번호") @RequestParam(required = false) Integer mixMatlNo, + @Parameter(description = "하제(망둥어)피치") @RequestParam(required = false) Integer roofPitch) throws QcastException { if (moduleTpCd == null || moduleTpCd.trim().isEmpty() || roofMatlCd == null || roofMatlCd.trim().isEmpty() || diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionRequest.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionRequest.java index f5598736..77e8624f 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionRequest.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionRequest.java @@ -1,51 +1,51 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiConstructionReq", description = "Api 시공법 목록 조회 요청 객체") +@Schema(description = "Api 시공법 목록 조회 요청 객체") public class ApiConstructionRequest { - /** Language Code */ + @Schema(description = "Language코드") private String langCd; - /** Module Type Code */ + @Schema(description = "모듈타입코드") private String moduleTpCd; - /** Roofing Material Code */ + @Schema(description = "지붕재코드") private String roofMatlCd; - /** Trestle Maker Code */ + @Schema(description = "가대메이커코드") private String trestleMkrCd; - /** Construction Method Code */ + @Schema(description = "공법코드") private String constMthdCd; - /** Roof Base Code */ + @Schema(description = "지붕기초코드") private String roofBaseCd; - /** Illumination Type */ + @Schema(description = "면조도") private String illuminationTp; - /** Installation Height */ + @Schema(description = "설치높이") private String instHt; - /** Standard Wind Speed */ + @Schema(description = "풍속") private String stdWindSpeed; - /** Standard Snow Load */ + @Schema(description = "적설량") private String stdSnowLd; - /** Incline Code */ + @Schema(description = "경사도코드") private String inclCd; - /** Rafter Base Code */ + @Schema(description = "서까래기초코드") private String raftBaseCd; - /** Roof Pitch */ + @Schema(description = "하제(망둥어)피치") private int roofPitch; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionResponse.java index c71184d9..aefabb74 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiConstructionResponse.java @@ -1,36 +1,36 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiConstructionRes", description = "Api 시공법 목록 조회 응답 객체") +@Schema(description = "Api 시공법 목록 조회 응답 객체") public class ApiConstructionResponse { - /** Construction Type */ + @Schema(description = "시공법") private String constTp; - /** Construction Type Name */ + @Schema(description = "시공법명") private String constTpNm; - /** Construction Type Japan */ + @Schema(description = "시공법명(일본)") private String constTpJp; - /** Construction Possible Yn */ + @Schema(description = "시공법가능여부") private String constPossYn; - /** Plover Possible Yn */ + @Schema(description = "치조가능여부") private String plvrYn; - /** Coverable Installation Possible Yn */ + @Schema(description = "처마커버설치가능여부") private String cvrYn; - /** Cover Limit Rows Single */ + @Schema(description = "처마커버설치최대단수") private int cvrLmtRow; - /** Snow Guard Installation Possible Yn */ + @Schema(description = "낙설방지금구설치가능여부") private String snowGdPossYn; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpRequest.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpRequest.java index 2153a217..9a2d4c26 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpRequest.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpRequest.java @@ -1,15 +1,17 @@ package com.interplug.qcast.biz.master.dto; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter +@Schema(description = "제품 요청 데이터") public class ApiModuleTpRequest { - /** Language Code */ + @Schema(description = "Language코드") private String langCd; - /** Roofing Material Code */ + @Schema(description = "지붕재코드") private String roofMatlCd; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiResponse.java index 292232a9..0c33033b 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiResponse.java @@ -1,13 +1,22 @@ package com.interplug.qcast.biz.master.dto; import java.util.List; + +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter +@Schema(description = "결과 데이터") public class ApiResponse { - private List data; - private List data2; - private ApiResultResponse result; + + @Schema(description = "목록 데이터") + private List data; + + @Schema(description = "목록 데이터2") + private List data2; + + @Schema(description = "API 결과 데이터") + private ApiResultResponse result; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailModuleResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailModuleResponse.java index a0870821..2b6bfa0d 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailModuleResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailModuleResponse.java @@ -1,33 +1,33 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleDetailModuleRes", description = "Api 가대 상세 모듈 조회 응답 객체") +@Schema(description = "Api 가대 상세 모듈 조회 응답 객체") public class ApiTrestleDetailModuleResponse { - /** Module Type Code */ + @Schema(description = "모듈타입코드(혼합제외)") private String moduleTpCd; - /** Long Axis mm */ + @Schema(description = "장경") private double longAxis; - /** Short Axis1 mm */ + @Schema(description = "단경") private double shortAxis; - /** Thickness */ + @Schema(description = "두께") private double thickness; - /** Color */ + @Schema(description = "색상") private String color; - /** Module Max Rows */ + @Schema(description = "모듈최대단수") private int moduleMaxRows; - /** Sort Order */ + @Schema(description = "순번") private int priority; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRackResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRackResponse.java index 6111a283..1a35044f 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRackResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRackResponse.java @@ -1,21 +1,21 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleDetailRackRes", description = "Api 가대 상세 랙 조회 응답 객체") +@Schema(description = "Api 가대 상세 랙 조회 응답 객체") public class ApiTrestleDetailRackResponse { - /** Module Rows */ + @Schema(description = "모듈총단수") private int moduleRows; - /** Rack Rows Codes */ + @Schema(description = "랙단수코드") private String rackRowsCds; - /** Intervals */ + @Schema(description = "간격") private String intvls; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRequest.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRequest.java index 85df7913..787fc387 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRequest.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailRequest.java @@ -1,54 +1,54 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleDetailReq", description = "Api 가대 상세 조회 요청 객체") +@Schema(description = "Api 가대 상세 조회 요청 객체") public class ApiTrestleDetailRequest { - /** Language Code */ + @Schema(description = "Language코드") private String langCd; - /** Module Type Code */ + @Schema(description = "모듈타입코드") private String moduleTpCd; - /** Roofing Material Code */ + @Schema(description = "지붕재코드") private String roofMatlCd; - /** Trestle Maker Code */ + @Schema(description = "가대메이커코드") private String trestleMkrCd; - /** Construction Method Code */ + @Schema(description = "공법코드") private String constMthdCd; - /** Roof Base Code */ + @Schema(description = "지붕기초코드") private String roofBaseCd; - /** Illumination Type */ + @Schema(description = "면조도") private String illuminationTp; - /** Installation Height */ + @Schema(description = "설치높이") private String instHt; - /** Standard Wind Speed */ + @Schema(description = "풍속") private String stdWindSpeed; - /** Standard Snow Load */ + @Schema(description = "적설량") private String stdSnowLd; - /** Incline Code */ + @Schema(description = "경사도코드") private String inclCd; - /** Construction Type */ + @Schema(description = "시공법") private String constTp; - /** Mix Meterial No */ + @Schema(description = "혼합모듈번호") private int mixMatlNo; - /** Roof Pitch */ + @Schema(description = "하제(망둥어)피치") private int roofPitch; - + } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailResponse.java index ff98771e..c068e0ff 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleDetailResponse.java @@ -2,61 +2,61 @@ package com.interplug.qcast.biz.master.dto; import java.util.List; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleDetailRes", description = "Api 가대 상세 조회 응답 객체") +@Schema(description = "Api 가대 상세 조회 응답 객체") public class ApiTrestleDetailResponse { - - /** Rack Yn */ + + @Schema(description = "랙여부") private String rackYn; - /** Plover Possible Yn */ + @Schema(description = "치조가능여부") private String plvrYn; - /** Module Max Rows */ + @Schema(description = "모듈최대단수") private int moduleMaxRows; - /** Module Max Columns */ + @Schema(description = "모듈최대열수") private int moduleMaxCols; - /** Eave Interval */ + @Schema(description = "지붕기준모듈설치간격-처마") private double eaveIntvl; - /** Ridge Interval */ + @Schema(description = "지붕기준모듈설치간격-용마루") private double ridgeIntvl; - /** Keraba Interval */ + @Schema(description = "지붕기준모듈설치간격-케라바") private double kerabaIntvl; - /** Module Interval Horizontal */ + @Schema(description = "모듈간간격-좌우") private double moduleIntvlHor; - /** Module Interval Vertical */ + @Schema(description = "모듈간간격-상하") private double moduleIntvlVer; - /** Cover Plover Possible Yn */ + @Schema(description = "치조배치 중단처마커버 설치가능여부") private String cvrPlvrYn; - /** Less Support Fittings Qty */ + @Schema(description = "랙리스지지금구수") private double lessSupFitQty; - /** Less Support Fittings Interval Percent */ + @Schema(description = "랙리스지지금구간격(모듈모서리기준)") private double lessSupFitIntvlPct; - /** Rack Qty */ + @Schema(description = "랙구성수량(모듈1개당)") private double rackQty; - /** Rack Interval Percent */ + @Schema(description = "랙구성간격(모듈좌우면기준)") private double rackIntvlPct; - /** Module List */ + @Schema(description = "Api 가대 상세 모듈 조회 응답 객체") private List module; - /** Rack List */ + @Schema(description = "Api 가대 상세 랙 조회 응답 객체") private List rack; } diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleRequest.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleRequest.java index 67af00a2..5621b2f2 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleRequest.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleRequest.java @@ -1,30 +1,30 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleReq", description = "Api 가대 목록 조회 요청 객체") +@Schema(description = "Api 가대 목록 조회 요청 객체") public class ApiTrestleRequest { - /** Module Type Code */ + @Schema(description = "모듈타입코드") private String moduleTpCd; - /** Roofing Material Code */ + @Schema(description = "지붕재코드") private String roofMatlCd; - /** Rafter Base Code */ + @Schema(description = "서까래기초코드") private String raftBaseCd; - /** Trestle Maker Code */ + @Schema(description = "가대메이커코드") private String trestleMkrCd; - /** Construction Method Code */ + @Schema(description = "공법코드") private String constMthdCd; - /** Roof Base Code */ + @Schema(description = "지붕기초코드") private String roofBaseCd; -} +} \ No newline at end of file diff --git a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleResponse.java b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleResponse.java index 4d446d91..f76c3a2a 100644 --- a/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleResponse.java +++ b/src/main/java/com/interplug/qcast/biz/master/dto/ApiTrestleResponse.java @@ -1,63 +1,63 @@ package com.interplug.qcast.biz.master.dto; -import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; import lombok.Setter; @Getter @Setter -@Tag(name = "ApiTrestleRes", description = "Api 가대 목록 조회 응답 객체") -public class ApiTrestleResponse { +@Schema(description = "Api 가대 목록 조회 응답 객체") +public class ApiTrestleResponse { - /** Module Type Code */ + @Schema(description = "모듈타입코드") private String moduleTpCd; - /** Module Type Code Name */ + @Schema(description = "모듈타입코드명") private String moduleTpCdNm; - /** Module Type Code Japan */ + @Schema(description = "모듈타입코드명(일본)") private String moduleTpCdJp; - /** Roofing Material Code */ + @Schema(description = "지붕재코드") private String roofMatlCd; - /** Roofing Material Code Name */ + @Schema(description = "지붕재코드명") private String roofMatlCdNm; - /** Roofing Material Code Japan */ + @Schema(description = "지붕재코드명(일본)") private String roofMatlCdJp; - /** Trestle Maker Code */ + @Schema(description = "가대메이커코드") private String trestleMkrCd; - /** Trestle Maker Code Name */ + @Schema(description = "가대메이커코드명") private String trestleMkrCdNm; - /** Trestle Maker Code Japan */ + @Schema(description = "가대메이커코드명(일본)") private String trestleMkrCdJp; - /** Construction Method Code */ + @Schema(description = "공법코드") private String constMthdCd; - /** Construction Method Code Name */ + @Schema(description = "공법코드명") private String constMthdCdNm; - /** Construction Method Code Japan */ + @Schema(description = "공법코드명(일본)") private String constMthdCdJp; - /** Roof Base Code */ + @Schema(description = "지붕기초코드") private String roofBaseCd; - /** Roof Base Code Name */ + @Schema(description = "지붕기초코드명") private String roofBaseCdNm; - /** Roof Base Code Japan */ + @Schema(description = "지붕기초코드명(일본)") private String roofBaseCdJp; - /** Rack Yn */ + @Schema(description = "랙 여부") private String rackYn; - /** Sort Order */ + @Schema(description = "순번") private int priority; -} +} \ No newline at end of file