api 설명 추가

src/main/java/com/interplug/qcast/biz/module/ModuleController.java

@@ -1,6 +1,8 @@
 package com.interplug.qcast.biz.module;
 
 import com.interplug.qcast.biz.module.dto.ModuleResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
@@ -8,10 +10,11 @@ import org.springframework.web.bind.annotation.*;
 @RestController
 @RequestMapping("/api/module")
 @RequiredArgsConstructor
+@Tag(name = "ModuleController", description = "모듈 관련 API")
 public class ModuleController {
   private final ModuleService moduleService;
 
-  // 모듈 조회
+  @Operation(description = "지붕재 ID와 가대 ID에 따라 설치 가능한 모듈 목록을 조회한다.")
   @GetMapping("/v1.0/modules/{roofMaterialId}/{trestleId}")
   public List<ModuleResponse> getModulesByRoofMaterialIdAndTrestleId(
       @PathVariable("roofMaterialId") Integer roofMaterialId,

src/main/java/com/interplug/qcast/biz/roofmaterial/RoofMaterialController.java

@@ -1,6 +1,8 @@
 package com.interplug.qcast.biz.roofmaterial;
 
 import com.interplug.qcast.biz.roofmaterial.dto.RoofMaterialResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -10,9 +12,11 @@ import org.springframework.web.bind.annotation.RestController;
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/roof-material")
+@Tag(name = "RoofMaterialController", description = "지붕재 API")
 public class RoofMaterialController {
   private final RoofMaterialService roofService;
 
+  @Operation(description = "지붕재 목록을 조회한다.")
   @GetMapping("/v1.0/roof-materials")
   public List<RoofMaterialResponse> getRoofMaterials() {
     return roofService.getRoofMaterials();

src/main/java/com/interplug/qcast/biz/trestle/TrestleController.java

@@ -1,6 +1,8 @@
 package com.interplug.qcast.biz.trestle;
 
 import com.interplug.qcast.biz.trestle.dto.TrestleResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
@@ -8,9 +10,11 @@ import org.springframework.web.bind.annotation.*;
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/trestle")
+@Tag(description = "가대 관련 API", name = "TrestleController")
 public class TrestleController {
   private final TrestleService trestleService;
 
+  @Operation(description = "지붕재 ID에 따라 가대 목록을 조회한다.")
   @GetMapping("/v1.0/trestles/{roofMaterialId}")
   public List<TrestleResponse> getTrestlesByRoofMaterialId(@PathVariable Integer roofMaterialId) {
     return trestleService.getTrestlesByRoofMaterialId(roofMaterialId);

src/main/resources/mappers/module/moduleMapper.xml

@@ -3,12 +3,12 @@
 
 <mapper namespace="com.interplug.qcast.biz.module.ModuleMapper">
     <select id="getModulesByRoofMaterialIdAndTrestleId" parameterType="integer" resultType="com.interplug.qcast.biz.module.dto.ModuleResponse">
-        select b.id
+        SELECT B.ID
-             , b.name
+             , B.NAME
-          from tb_map_roof_material_trestle_module a
+          FROM TB_MAP_ROOF_MATERIAL_TRESTLE_MODULE A
-          join tb_module b
+          JOIN TB_MODULE B
-            on a.MODULE_ID = b.ID
+            ON A.MODULE_ID = B.ID
-         where a.roof_material_id = #{roofMaterialId}
+         WHERE A.ROOF_MATERIAL_ID = #{roofMaterialId}
-           and a.trestle_id = #{trestleId}
+           AND A.TRESTLE_ID =       #{trestleId}
     </select>
 </mapper>

src/main/resources/mappers/roofmaterial/roofMaterialMapper.xml

@@ -3,8 +3,8 @@
 
 <mapper namespace="com.interplug.qcast.biz.roofmaterial.RoofMaterialMapper">
     <select id="getRoofMaterials" resultType="com.interplug.qcast.biz.roofmaterial.dto.RoofMaterialResponse">
-        select id
+        SELECT ID
-             , name
+             , NAME
-          from TB_ROOF_MATERIAL
+          FROM TB_ROOF_MATERIAL
     </select>
 </mapper>

src/main/resources/mappers/trestle/trestleMapper.xml

@@ -4,15 +4,15 @@
 <mapper namespace="com.interplug.qcast.biz.trestle.TrestleMapper">
     <select id="getTrestlesByRoofMaterialId" parameterType="integer"
             resultType="com.interplug.qcast.biz.trestle.dto.TrestleResponse">
-        select a.trestle_id as id
+        SELECT A.TRESTLE_ID AS ID
-             , b.name       as name
+             , B.NAME       AS NAME
-             , c.id         as manufacturerId
+             , C.ID         AS MANUFACTURERID
-             , c.name       as manufacturerName
+             , C.NAME       AS MANUFACTURERNAME
-          from tb_map_roof_material_trestle a
+          FROM TB_MAP_ROOF_MATERIAL_TRESTLE A
-          join tb_trestle b
+          JOIN TB_TRESTLE B
-            on a.trestle_id = b.id
+            ON A.TRESTLE_ID = B.ID
-          join tb_manufacturer c
+          JOIN TB_MANUFACTURER C
-            on b.manufacturer_id = c.id
+            ON B.MANUFACTURER_ID = C.ID
-         where a.roof_material_id = #{roofMaterialId}
+         WHERE A.ROOF_MATERIAL_ID = #{roofMaterialId}
     </select>
 </mapper>