Swagger 주석 추가
This commit is contained in:
parent
6383a075da
commit
c0c564de4f
@ -3,6 +3,8 @@ package com.interplug.qcast.biz.object;
|
|||||||
import com.interplug.qcast.biz.object.dto.ObjectRequest;
|
import com.interplug.qcast.biz.object.dto.ObjectRequest;
|
||||||
import com.interplug.qcast.biz.object.dto.ObjectResponse;
|
import com.interplug.qcast.biz.object.dto.ObjectResponse;
|
||||||
import com.interplug.qcast.biz.object.dto.PlanRequest;
|
import com.interplug.qcast.biz.object.dto.PlanRequest;
|
||||||
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||||
import lombok.RequiredArgsConstructor;
|
import lombok.RequiredArgsConstructor;
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.springframework.http.HttpStatus;
|
import org.springframework.http.HttpStatus;
|
||||||
@ -14,46 +16,54 @@ import java.util.List;
|
|||||||
@RestController
|
@RestController
|
||||||
@RequestMapping("/api/object")
|
@RequestMapping("/api/object")
|
||||||
@RequiredArgsConstructor
|
@RequiredArgsConstructor
|
||||||
|
@Tag(name = "ObjectController", description = "물건정보 관련 API")
|
||||||
public class ObjectController {
|
public class ObjectController {
|
||||||
// @Autowired private ObjectService objectService;
|
// @Autowired private ObjectService objectService;
|
||||||
private final ObjectService objectService;
|
private final ObjectService objectService;
|
||||||
|
|
||||||
|
@Operation(description = "물건정보 목록을 조회한다.")
|
||||||
@GetMapping("/v1.0/object")
|
@GetMapping("/v1.0/object")
|
||||||
@ResponseStatus(HttpStatus.OK)
|
@ResponseStatus(HttpStatus.OK)
|
||||||
public List<ObjectResponse> selectObjectList(ObjectRequest objectRequest) throws Exception {
|
public List<ObjectResponse> selectObjectList(ObjectRequest objectRequest) throws Exception {
|
||||||
return objectService.selectObjectList(objectRequest);
|
return objectService.selectObjectList(objectRequest);
|
||||||
}
|
}
|
||||||
|
|
||||||
@GetMapping("/v1.0/object/{objectNo}/{planNo}")
|
@Operation(description = "물건정보 상세를 조회한다.")
|
||||||
|
@GetMapping("/v1.0/object/{objectNo}")
|
||||||
@ResponseStatus(HttpStatus.OK)
|
@ResponseStatus(HttpStatus.OK)
|
||||||
public ObjectResponse selectObjectDetail(@PathVariable String objectNo, @PathVariable String planNo) throws Exception {
|
public ObjectResponse selectObjectDetail(@PathVariable String objectNo) throws Exception {
|
||||||
return objectService.selectObjectDetail(objectNo, planNo);
|
return objectService.selectObjectDetail(objectNo);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Operation(description = "물건정보을 저장한다.")
|
||||||
@PostMapping("/v1.0/object")
|
@PostMapping("/v1.0/object")
|
||||||
@ResponseStatus(HttpStatus.CREATED)
|
@ResponseStatus(HttpStatus.CREATED)
|
||||||
public ObjectResponse insertObject(@RequestBody ObjectRequest objectRequest) throws Exception {
|
public ObjectResponse insertObject(@RequestBody ObjectRequest objectRequest) throws Exception {
|
||||||
return objectService.insertObject(objectRequest);
|
return objectService.insertObject(objectRequest);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Operation(description = "물건정보을 수정한다.")
|
||||||
@PutMapping("/v1.0/object")
|
@PutMapping("/v1.0/object")
|
||||||
@ResponseStatus(HttpStatus.CREATED)
|
@ResponseStatus(HttpStatus.CREATED)
|
||||||
public void updateObject(@RequestBody ObjectRequest objectRequest) throws Exception {
|
public void updateObject(@RequestBody ObjectRequest objectRequest) throws Exception {
|
||||||
int reust = objectService.updateObject(objectRequest);
|
int reust = objectService.updateObject(objectRequest);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Operation(description = "물건정보을 삭제한다.")
|
||||||
@DeleteMapping("/v1.0/object/{objectNo}")
|
@DeleteMapping("/v1.0/object/{objectNo}")
|
||||||
@ResponseStatus(HttpStatus.NO_CONTENT)
|
@ResponseStatus(HttpStatus.NO_CONTENT)
|
||||||
public void deleteObject(@PathVariable String objectNo) throws Exception {
|
public void deleteObject(@PathVariable String objectNo) throws Exception {
|
||||||
objectService.deleteObject(objectNo);
|
objectService.deleteObject(objectNo);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Operation(description = "물건정보의 플랜정보를 추가한다.")
|
||||||
@PostMapping("/v1.0/object/plan")
|
@PostMapping("/v1.0/object/plan")
|
||||||
@ResponseStatus(HttpStatus.CREATED)
|
@ResponseStatus(HttpStatus.CREATED)
|
||||||
public void insertPlan(@RequestBody PlanRequest planRequest) throws Exception {
|
public void insertPlan(@RequestBody PlanRequest planRequest) throws Exception {
|
||||||
objectService.insertPlan(planRequest);
|
objectService.insertPlan(planRequest);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Operation(description = "물건정보의 플랜정보를 삭제한다.")
|
||||||
@DeleteMapping("/v1.0/object/plan/{objectNo}/{planNo}")
|
@DeleteMapping("/v1.0/object/plan/{objectNo}/{planNo}")
|
||||||
@ResponseStatus(HttpStatus.NO_CONTENT)
|
@ResponseStatus(HttpStatus.NO_CONTENT)
|
||||||
public void deletePlan(@PathVariable String objectNo, @PathVariable String planNo) throws Exception {
|
public void deletePlan(@PathVariable String objectNo, @PathVariable String planNo) throws Exception {
|
||||||
|
|||||||
@ -35,13 +35,13 @@ public class ObjectService {
|
|||||||
return objectMapper.selectObjectList(objectRequest);
|
return objectMapper.selectObjectList(objectRequest);
|
||||||
}
|
}
|
||||||
|
|
||||||
public ObjectResponse selectObjectDetail(String objectNo, String planNo) throws Exception {
|
public ObjectResponse selectObjectDetail(String objectNo) throws Exception {
|
||||||
ObjectResponse objectResponse = new ObjectResponse();
|
ObjectResponse objectResponse = new ObjectResponse();
|
||||||
|
|
||||||
// object 상세 정보 조회
|
// object 상세 정보 조회
|
||||||
objectResponse = objectMapper.selectObjectDetail(objectNo);
|
objectResponse = objectMapper.selectObjectDetail(objectNo);
|
||||||
// 선택한 플랜번호 셋팅
|
// 기본 플랜번호 셋팅
|
||||||
objectResponse.setPlanNo(planNo);
|
objectResponse.setPlanNo("1");
|
||||||
|
|
||||||
if (objectResponse != null) {
|
if (objectResponse != null) {
|
||||||
// ini 파일 읽어 Response 객체 담기
|
// ini 파일 읽어 Response 객체 담기
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user