qcast3/qcast-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: swagger description 추가

Browse Source 
- 지붕재 목록 조회 api, 모듈 타입별 아이템 목록 조회 api
This commit is contained in:
Daseul Kim 2024-12-23 18:00:29 +09:00
parent b2e2bbabc3
commit 8c71c2403f
5 changed files with 44 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/java/com/interplug/qcast/biz/master/MasterController.java
View File

@ -9,6 +9,7 @@ import com.interplug.qcast.biz.master.dto.ApiTrestleResponse;
import com.interplug.qcast.config.Exception.ErrorCode;
import com.interplug.qcast.config.Exception.QcastException;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import java.util.List;
import lombok.RequiredArgsConstructor;
@ -33,7 +34,9 @@ public class MasterController {
@Operation(description = "모듈 타입별 아이템 목록을 조회한다.")
@GetMapping("/getModuleTypeItemList")
public ApiResponse<ApiModuleTpResponse> getModuleTypeItemList(
@RequestParam("arrRoofMatlCd") List<String> roofMaterialCd) throws QcastException {
@Parameter(description = "지붕재 코드 목록") @RequestParam("arrRoofMatlCd")
List<String> roofMaterialCd)
throws QcastException {
if (roofMaterialCd == null
|| roofMaterialCd.isEmpty()
|| roofMaterialCd.size() > 4

21
src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpItemResponse.java
View File

@ -1,5 +1,6 @@
package com.interplug.qcast.biz.master.dto;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;
@ -7,33 +8,33 @@ import lombok.Setter;
@Setter
public class ApiModuleTpItemResponse {
/** Item Id */
@Schema(description = "제품ID")
private String itemId;
/** Item Name */
@Schema(description = "제품명")
private String itemNm;
/** Basic Materail */
@Schema(description = "제품명(Basic Material)")
private String goodsNo;
/** Item Type(A1, A2, A1A2, B, B1 등등) */
@Schema(description = "제품타입(A1, A2, A1A2, B, B1...)")
private String itemTp;
/** Color */
@Schema(description = "색상")
private String color;
/** Long Axix(장경) */
@Schema(description = "장경")
private String longAxis;
/** Short Axis(단경1) */
@Schema(description = "단경")
private String shortAxis;
/** Thickness(두께) */
@Schema(description = "두께")
private String thickness;
/** Power Class */
@Schema(description = "제품용량")
private String wpOut;
/** Mix Module No */
@Schema(description = "혼합모듈번호")
private String mixMatlNo;
}

16
src/main/java/com/interplug/qcast/biz/master/dto/ApiModuleTpResponse.java
View File

@ -1,31 +1,33 @@
package com.interplug.qcast.biz.master.dto;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
@Getter
@Setter
@Schema(description = "제품 데이터")
public class ApiModuleTpResponse {
/** Item Id */
@Schema(description = "제품ID")
private String itemId;
/** Item Name */
@Schema(description = "제품명")
private String itemNm;
/** Basic Materail */
@Schema(description = "제품명(Basic Material)")
private String goodsNo;
/** Item Type(A1, A2, A1A2, B, B1 등등) */
@Schema(description = "제품타입(A1, A2, A1A2, B, B1...)")
private String itemTp;
/** Mix Module No */
@Schema(description = "혼합모듈번호")
private String mixMatlNo;
/** Mix Module Yn */
@Schema(description = "혼합모듈여부")
private String mixItemTpYn;
/** Module Type Code Japan */
@Schema(description = "제품 상세 데이터")
private List<ApiModuleTpItemResponse> itemList;
}

7
src/main/java/com/interplug/qcast/biz/master/dto/ApiResultResponse.java
View File

@ -1,13 +1,20 @@
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 = "API 결과 데이터")
public class ApiResultResponse {
@Schema(description = "결과 코드")
private Integer code;
private String resultCode;
@Schema(description = "결과 메시지")
private String message;
private String resultMsg;
}

24
src/main/java/com/interplug/qcast/biz/master/dto/ApiRoofMaterialResponse.java
View File

@ -1,42 +1,44 @@
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 ApiRoofMaterialResponse {
/** Roof Material Code */
@Schema(description = "지붕재코드")
private String roofMatlCd;
/** Roof Material Code Name */
@Schema(description = "지붕재코드명")
private String roofMatlNm;
/** Roof Material Code Name Japan */
@Schema(description = "지붕재코드명(일본)")
private String roofMatlNmJp;
/** Width Auth(R:READ, C: Create, 빈값:미노출) */
@Schema(description = "Width 권한(R:조회, C: 등록, 빈값:미노출)")
private String widAuth;
/** Width Base */
@Schema(description = "Width 기본 수치")
private String widBase;
/** Length Auth(R:READ, C: Create, 빈값:미노출) */
@Schema(description = "Length 권한(R:조회, C: 등록, 빈값:미노출)")
private String lenAuth;
/** Length Base */
@Schema(description = "Length 기본 수치")
private String lenBase;
/** Roof Pitch Auth(R:READ, C: Create, 빈값:미노출) */
@Schema(description = "하재피치 권한(R:조회, C: 등록, 빈값:미노출)")
private String roofPchAuth;
/** Roof Pitch Base */
@Schema(description = "하재피치 기본 수치")
private String roofPchBase;
/** Rafter Auth(R:READ, C: Create, 빈값:미노출) */
@Schema(description = "서까래 권한(R:조회, C: 등록, 빈값:미노출)")
private String raftAuth;
/** Rafter Base */
@Schema(description = "서까래 기본 수치")
private String raftBaseCd;
}