api description 추가

This commit is contained in:
changkyu choi 2024-12-24 10:47:02 +09:00
parent 8c71c2403f
commit 51516b8d0b
11 changed files with 155 additions and 144 deletions

View File

@ -46,34 +46,34 @@ public class MasterController {
return masterService.getModuleTypeItemList(roofMaterialCd); return masterService.getModuleTypeItemList(roofMaterialCd);
} }
@Operation(description = "가대 목록 조회") @Operation(description = "가대 목록 조회한다.")
@GetMapping("/getTrestleList") @GetMapping("/getTrestleList")
public ApiResponse<ApiTrestleResponse> getTrestleList( public ApiResponse<ApiTrestleResponse> getTrestleList(
@RequestParam(required = false) String moduleTpCd, @Parameter(description = "모듈타입코드") @RequestParam(required = false) String moduleTpCd,
@RequestParam(required = false) String roofMatlCd, @Parameter(description = "지붕재코드") @RequestParam(required = false) String roofMatlCd,
@RequestParam(required = false) String raftBaseCd, @Parameter(description = "서까래기초코드") @RequestParam(required = false) String raftBaseCd,
@RequestParam(required = false) String trestleMkrCd, @Parameter(description = "가대메이커코드") @RequestParam(required = false) String trestleMkrCd,
@RequestParam(required = false) String constMthdCd, @Parameter(description = "공법코드") @RequestParam(required = false) String constMthdCd,
@RequestParam(required = false) String roofBaseCd) { @Parameter(description = "지붕기초코드") @RequestParam(required = false) String roofBaseCd) {
return masterService.getTrestleList(moduleTpCd,roofMatlCd,raftBaseCd,trestleMkrCd,constMthdCd,roofBaseCd); return masterService.getTrestleList(moduleTpCd,roofMatlCd,raftBaseCd,trestleMkrCd,constMthdCd,roofBaseCd);
} }
@Operation(description = "시공법 목록 조회") @Operation(description = "시공법 목록 조회한다.")
@GetMapping("/getConstructionList") @GetMapping("/getConstructionList")
public ApiResponse<ApiConstructionResponse> getConstructionList( public ApiResponse<ApiConstructionResponse> getConstructionList(
@RequestParam String moduleTpCd, @Parameter(description = "모듈타입코드") @RequestParam String moduleTpCd,
@RequestParam String roofMatlCd, @Parameter(description = "지붕재코드") @RequestParam String roofMatlCd,
@RequestParam String trestleMkrCd, @Parameter(description = "가대메이커코드") @RequestParam String trestleMkrCd,
@RequestParam String constMthdCd, @Parameter(description = "공법코드") @RequestParam String constMthdCd,
@RequestParam String roofBaseCd, @Parameter(description = "지붕기초코드") @RequestParam String roofBaseCd,
@RequestParam String illuminationTp, @Parameter(description = "면조도") @RequestParam String illuminationTp,
@RequestParam String instHt, @Parameter(description = "설치높이") @RequestParam String instHt,
@RequestParam String stdWindSpeed, @Parameter(description = "풍속") @RequestParam String stdWindSpeed,
@RequestParam String stdSnowLd, @Parameter(description = "적설량") @RequestParam String stdSnowLd,
@RequestParam String inclCd, @Parameter(description = "경사도코드") @RequestParam String inclCd,
@RequestParam(required = false) String raftBaseCd, @Parameter(description = "서까래기초코드") @RequestParam(required = false) String raftBaseCd,
@RequestParam(required = false) Integer roofPitch) throws QcastException { @Parameter(description = "하제(망둥어)피치") @RequestParam(required = false) Integer roofPitch) throws QcastException {
if (moduleTpCd == null || moduleTpCd.trim().isEmpty() || if (moduleTpCd == null || moduleTpCd.trim().isEmpty() ||
roofMatlCd == null || roofMatlCd.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); return masterService.getConstructionList(moduleTpCd, roofMatlCd, trestleMkrCd, constMthdCd, roofBaseCd, illuminationTp, instHt, stdWindSpeed, stdSnowLd, inclCd, raftBaseCd, roofPitch);
} }
@Operation(description = "가대 상세 조회") @Operation(description = "가대 상세 조회한다.")
@GetMapping("/getTrestleDetailList") @GetMapping("/getTrestleDetailList")
public ApiResponse<ApiTrestleDetailResponse> getTrestleDetailList( public ApiResponse<ApiTrestleDetailResponse> getTrestleDetailList(
@RequestParam String moduleTpCd, @Parameter(description = "모듈타입코드") @RequestParam String moduleTpCd,
@RequestParam String roofMatlCd, @Parameter(description = "지붕재코드") @RequestParam String roofMatlCd,
@RequestParam String trestleMkrCd, @Parameter(description = "가대메이커코드") @RequestParam String trestleMkrCd,
@RequestParam String constMthdCd, @Parameter(description = "공법코드") @RequestParam String constMthdCd,
@RequestParam String roofBaseCd, @Parameter(description = "지붕기초코드") @RequestParam String roofBaseCd,
@RequestParam String illuminationTp, @Parameter(description = "면조도") @RequestParam String illuminationTp,
@RequestParam String instHt, @Parameter(description = "설치높이") @RequestParam String instHt,
@RequestParam String stdWindSpeed, @Parameter(description = "풍속") @RequestParam String stdWindSpeed,
@RequestParam String stdSnowLd, @Parameter(description = "적설량") @RequestParam String stdSnowLd,
@RequestParam String inclCd, @Parameter(description = "경사도코드") @RequestParam String inclCd,
@RequestParam String constTp, @Parameter(description = "시공법") @RequestParam String constTp,
@RequestParam(required = false) Integer mixMatlNo, @Parameter(description = "혼합모듈번호") @RequestParam(required = false) Integer mixMatlNo,
@RequestParam(required = false) Integer roofPitch) throws QcastException { @Parameter(description = "하제(망둥어)피치") @RequestParam(required = false) Integer roofPitch) throws QcastException {
if (moduleTpCd == null || moduleTpCd.trim().isEmpty() || if (moduleTpCd == null || moduleTpCd.trim().isEmpty() ||
roofMatlCd == null || roofMatlCd.trim().isEmpty() || roofMatlCd == null || roofMatlCd.trim().isEmpty() ||

View File

@ -1,51 +1,51 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiConstructionReq", description = "Api 시공법 목록 조회 요청 객체") @Schema(description = "Api 시공법 목록 조회 요청 객체")
public class ApiConstructionRequest { public class ApiConstructionRequest {
/** Language Code */ @Schema(description = "Language코드")
private String langCd; private String langCd;
/** Module Type Code */ @Schema(description = "모듈타입코드")
private String moduleTpCd; private String moduleTpCd;
/** Roofing Material Code */ @Schema(description = "지붕재코드")
private String roofMatlCd; private String roofMatlCd;
/** Trestle Maker Code */ @Schema(description = "가대메이커코드")
private String trestleMkrCd; private String trestleMkrCd;
/** Construction Method Code */ @Schema(description = "공법코드")
private String constMthdCd; private String constMthdCd;
/** Roof Base Code */ @Schema(description = "지붕기초코드")
private String roofBaseCd; private String roofBaseCd;
/** Illumination Type */ @Schema(description = "면조도")
private String illuminationTp; private String illuminationTp;
/** Installation Height */ @Schema(description = "설치높이")
private String instHt; private String instHt;
/** Standard Wind Speed */ @Schema(description = "풍속")
private String stdWindSpeed; private String stdWindSpeed;
/** Standard Snow Load */ @Schema(description = "적설량")
private String stdSnowLd; private String stdSnowLd;
/** Incline Code */ @Schema(description = "경사도코드")
private String inclCd; private String inclCd;
/** Rafter Base Code */ @Schema(description = "서까래기초코드")
private String raftBaseCd; private String raftBaseCd;
/** Roof Pitch */ @Schema(description = "하제(망둥어)피치")
private int roofPitch; private int roofPitch;
} }

View File

@ -1,36 +1,36 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiConstructionRes", description = "Api 시공법 목록 조회 응답 객체") @Schema(description = "Api 시공법 목록 조회 응답 객체")
public class ApiConstructionResponse { public class ApiConstructionResponse {
/** Construction Type */ @Schema(description = "시공법")
private String constTp; private String constTp;
/** Construction Type Name */ @Schema(description = "시공법명")
private String constTpNm; private String constTpNm;
/** Construction Type Japan */ @Schema(description = "시공법명(일본)")
private String constTpJp; private String constTpJp;
/** Construction Possible Yn */ @Schema(description = "시공법가능여부")
private String constPossYn; private String constPossYn;
/** Plover Possible Yn */ @Schema(description = "치조가능여부")
private String plvrYn; private String plvrYn;
/** Coverable Installation Possible Yn */ @Schema(description = "처마커버설치가능여부")
private String cvrYn; private String cvrYn;
/** Cover Limit Rows Single */ @Schema(description = "처마커버설치최대단수")
private int cvrLmtRow; private int cvrLmtRow;
/** Snow Guard Installation Possible Yn */ @Schema(description = "낙설방지금구설치가능여부")
private String snowGdPossYn; private String snowGdPossYn;
} }

View File

@ -1,15 +1,17 @@
package com.interplug.qcast.biz.master.dto; package com.interplug.qcast.biz.master.dto;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Schema(description = "제품 요청 데이터")
public class ApiModuleTpRequest { public class ApiModuleTpRequest {
/** Language Code */ @Schema(description = "Language코드")
private String langCd; private String langCd;
/** Roofing Material Code */ @Schema(description = "지붕재코드")
private String roofMatlCd; private String roofMatlCd;
} }

View File

@ -1,13 +1,22 @@
package com.interplug.qcast.biz.master.dto; package com.interplug.qcast.biz.master.dto;
import java.util.List; import java.util.List;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Schema(description = "결과 데이터")
public class ApiResponse<T> { public class ApiResponse<T> {
private List<T> data;
private List<T> data2; @Schema(description = "목록 데이터")
private ApiResultResponse result; private List<T> data;
@Schema(description = "목록 데이터2")
private List<T> data2;
@Schema(description = "API 결과 데이터")
private ApiResultResponse result;
} }

View File

@ -1,33 +1,33 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleDetailModuleRes", description = "Api 가대 상세 모듈 조회 응답 객체") @Schema(description = "Api 가대 상세 모듈 조회 응답 객체")
public class ApiTrestleDetailModuleResponse { public class ApiTrestleDetailModuleResponse {
/** Module Type Code */ @Schema(description = "모듈타입코드(혼합제외)")
private String moduleTpCd; private String moduleTpCd;
/** Long Axis mm */ @Schema(description = "장경")
private double longAxis; private double longAxis;
/** Short Axis1 mm */ @Schema(description = "단경")
private double shortAxis; private double shortAxis;
/** Thickness */ @Schema(description = "두께")
private double thickness; private double thickness;
/** Color */ @Schema(description = "색상")
private String color; private String color;
/** Module Max Rows */ @Schema(description = "모듈최대단수")
private int moduleMaxRows; private int moduleMaxRows;
/** Sort Order */ @Schema(description = "순번")
private int priority; private int priority;
} }

View File

@ -1,21 +1,21 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleDetailRackRes", description = "Api 가대 상세 랙 조회 응답 객체") @Schema(description = "Api 가대 상세 랙 조회 응답 객체")
public class ApiTrestleDetailRackResponse { public class ApiTrestleDetailRackResponse {
/** Module Rows */ @Schema(description = "모듈총단수")
private int moduleRows; private int moduleRows;
/** Rack Rows Codes */ @Schema(description = "랙단수코드")
private String rackRowsCds; private String rackRowsCds;
/** Intervals */ @Schema(description = "간격")
private String intvls; private String intvls;
} }

View File

@ -1,54 +1,54 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleDetailReq", description = "Api 가대 상세 조회 요청 객체") @Schema(description = "Api 가대 상세 조회 요청 객체")
public class ApiTrestleDetailRequest { public class ApiTrestleDetailRequest {
/** Language Code */ @Schema(description = "Language코드")
private String langCd; private String langCd;
/** Module Type Code */ @Schema(description = "모듈타입코드")
private String moduleTpCd; private String moduleTpCd;
/** Roofing Material Code */ @Schema(description = "지붕재코드")
private String roofMatlCd; private String roofMatlCd;
/** Trestle Maker Code */ @Schema(description = "가대메이커코드")
private String trestleMkrCd; private String trestleMkrCd;
/** Construction Method Code */ @Schema(description = "공법코드")
private String constMthdCd; private String constMthdCd;
/** Roof Base Code */ @Schema(description = "지붕기초코드")
private String roofBaseCd; private String roofBaseCd;
/** Illumination Type */ @Schema(description = "면조도")
private String illuminationTp; private String illuminationTp;
/** Installation Height */ @Schema(description = "설치높이")
private String instHt; private String instHt;
/** Standard Wind Speed */ @Schema(description = "풍속")
private String stdWindSpeed; private String stdWindSpeed;
/** Standard Snow Load */ @Schema(description = "적설량")
private String stdSnowLd; private String stdSnowLd;
/** Incline Code */ @Schema(description = "경사도코드")
private String inclCd; private String inclCd;
/** Construction Type */ @Schema(description = "시공법")
private String constTp; private String constTp;
/** Mix Meterial No */ @Schema(description = "혼합모듈번호")
private int mixMatlNo; private int mixMatlNo;
/** Roof Pitch */ @Schema(description = "하제(망둥어)피치")
private int roofPitch; private int roofPitch;
} }

View File

@ -2,61 +2,61 @@ package com.interplug.qcast.biz.master.dto;
import java.util.List; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleDetailRes", description = "Api 가대 상세 조회 응답 객체") @Schema(description = "Api 가대 상세 조회 응답 객체")
public class ApiTrestleDetailResponse { public class ApiTrestleDetailResponse {
/** Rack Yn */ @Schema(description = "랙여부")
private String rackYn; private String rackYn;
/** Plover Possible Yn */ @Schema(description = "치조가능여부")
private String plvrYn; private String plvrYn;
/** Module Max Rows */ @Schema(description = "모듈최대단수")
private int moduleMaxRows; private int moduleMaxRows;
/** Module Max Columns */ @Schema(description = "모듈최대열수")
private int moduleMaxCols; private int moduleMaxCols;
/** Eave Interval */ @Schema(description = "지붕기준모듈설치간격-처마")
private double eaveIntvl; private double eaveIntvl;
/** Ridge Interval */ @Schema(description = "지붕기준모듈설치간격-용마루")
private double ridgeIntvl; private double ridgeIntvl;
/** Keraba Interval */ @Schema(description = "지붕기준모듈설치간격-케라바")
private double kerabaIntvl; private double kerabaIntvl;
/** Module Interval Horizontal */ @Schema(description = "모듈간간격-좌우")
private double moduleIntvlHor; private double moduleIntvlHor;
/** Module Interval Vertical */ @Schema(description = "모듈간간격-상하")
private double moduleIntvlVer; private double moduleIntvlVer;
/** Cover Plover Possible Yn */ @Schema(description = "치조배치 중단처마커버 설치가능여부")
private String cvrPlvrYn; private String cvrPlvrYn;
/** Less Support Fittings Qty */ @Schema(description = "랙리스지지금구수")
private double lessSupFitQty; private double lessSupFitQty;
/** Less Support Fittings Interval Percent */ @Schema(description = "랙리스지지금구간격(모듈모서리기준)")
private double lessSupFitIntvlPct; private double lessSupFitIntvlPct;
/** Rack Qty */ @Schema(description = "랙구성수량(모듈1개당)")
private double rackQty; private double rackQty;
/** Rack Interval Percent */ @Schema(description = "랙구성간격(모듈좌우면기준)")
private double rackIntvlPct; private double rackIntvlPct;
/** Module List */ @Schema(description = "Api 가대 상세 모듈 조회 응답 객체")
private List<ApiTrestleDetailModuleResponse> module; private List<ApiTrestleDetailModuleResponse> module;
/** Rack List */ @Schema(description = "Api 가대 상세 랙 조회 응답 객체")
private List<ApiTrestleDetailRackResponse> rack; private List<ApiTrestleDetailRackResponse> rack;
} }

View File

@ -1,30 +1,30 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleReq", description = "Api 가대 목록 조회 요청 객체") @Schema(description = "Api 가대 목록 조회 요청 객체")
public class ApiTrestleRequest { public class ApiTrestleRequest {
/** Module Type Code */ @Schema(description = "모듈타입코드")
private String moduleTpCd; private String moduleTpCd;
/** Roofing Material Code */ @Schema(description = "지붕재코드")
private String roofMatlCd; private String roofMatlCd;
/** Rafter Base Code */ @Schema(description = "서까래기초코드")
private String raftBaseCd; private String raftBaseCd;
/** Trestle Maker Code */ @Schema(description = "가대메이커코드")
private String trestleMkrCd; private String trestleMkrCd;
/** Construction Method Code */ @Schema(description = "공법코드")
private String constMthdCd; private String constMthdCd;
/** Roof Base Code */ @Schema(description = "지붕기초코드")
private String roofBaseCd; private String roofBaseCd;
} }

View File

@ -1,63 +1,63 @@
package com.interplug.qcast.biz.master.dto; 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.Getter;
import lombok.Setter; import lombok.Setter;
@Getter @Getter
@Setter @Setter
@Tag(name = "ApiTrestleRes", description = "Api 가대 목록 조회 응답 객체") @Schema(description = "Api 가대 목록 조회 응답 객체")
public class ApiTrestleResponse { public class ApiTrestleResponse {
/** Module Type Code */ @Schema(description = "모듈타입코드")
private String moduleTpCd; private String moduleTpCd;
/** Module Type Code Name */ @Schema(description = "모듈타입코드명")
private String moduleTpCdNm; private String moduleTpCdNm;
/** Module Type Code Japan */ @Schema(description = "모듈타입코드명(일본)")
private String moduleTpCdJp; private String moduleTpCdJp;
/** Roofing Material Code */ @Schema(description = "지붕재코드")
private String roofMatlCd; private String roofMatlCd;
/** Roofing Material Code Name */ @Schema(description = "지붕재코드명")
private String roofMatlCdNm; private String roofMatlCdNm;
/** Roofing Material Code Japan */ @Schema(description = "지붕재코드명(일본)")
private String roofMatlCdJp; private String roofMatlCdJp;
/** Trestle Maker Code */ @Schema(description = "가대메이커코드")
private String trestleMkrCd; private String trestleMkrCd;
/** Trestle Maker Code Name */ @Schema(description = "가대메이커코드명")
private String trestleMkrCdNm; private String trestleMkrCdNm;
/** Trestle Maker Code Japan */ @Schema(description = "가대메이커코드명(일본)")
private String trestleMkrCdJp; private String trestleMkrCdJp;
/** Construction Method Code */ @Schema(description = "공법코드")
private String constMthdCd; private String constMthdCd;
/** Construction Method Code Name */ @Schema(description = "공법코드명")
private String constMthdCdNm; private String constMthdCdNm;
/** Construction Method Code Japan */ @Schema(description = "공법코드명(일본)")
private String constMthdCdJp; private String constMthdCdJp;
/** Roof Base Code */ @Schema(description = "지붕기초코드")
private String roofBaseCd; private String roofBaseCd;
/** Roof Base Code Name */ @Schema(description = "지붕기초코드명")
private String roofBaseCdNm; private String roofBaseCdNm;
/** Roof Base Code Japan */ @Schema(description = "지붕기초코드명(일본)")
private String roofBaseCdJp; private String roofBaseCdJp;
/** Rack Yn */ @Schema(description = "랙 여부")
private String rackYn; private String rackYn;
/** Sort Order */ @Schema(description = "순번")
private int priority; private int priority;
} }