api sample

This commit is contained in:
2025-11-17 09:39:18 +09:00
parent 74e1c6bb9c
commit 7d64ee897d
29 changed files with 918 additions and 126 deletions

View File

@@ -0,0 +1,82 @@
package com.kamco.cd.kamcoback.zoo;
import com.kamco.cd.kamcoback.zoo.dto.AnimalDto;
import com.kamco.cd.kamcoback.zoo.dto.AnimalDto.Category;
import com.kamco.cd.kamcoback.zoo.dto.AnimalDto.Species;
import com.kamco.cd.kamcoback.zoo.service.AnimalService;
import lombok.RequiredArgsConstructor;
import org.springframework.data.domain.Page;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
@RequiredArgsConstructor
@RestController
@RequestMapping({"/api/animals", "/v1/api/animals"})
public class AnimalApiController {
private final AnimalService animalService;
/**
* 동물 생성
*
* @param req 동물 생성 요청
* @return 생성된 동물 정보
*/
@PostMapping
public ResponseEntity<AnimalDto.Basic> createAnimal(@RequestBody AnimalDto.AddReq req) {
AnimalDto.Basic created = animalService.createAnimal(req);
return ResponseEntity.status(HttpStatus.CREATED).body(created);
}
/**
* UUID로 동물 조회
*
* @param uuid 동물 UUID
* @return 동물 정보
*/
@GetMapping("/{uuid}")
public ResponseEntity<AnimalDto.Basic> getAnimal(@PathVariable String uuid) {
Long id = animalService.getAnimalByUuid(uuid);
AnimalDto.Basic animal = animalService.getAnimal(id);
return ResponseEntity.ok(animal);
}
/**
* UUID로 동물 삭제 (논리 삭제)
*
* @param uuid 동물 UUID
* @return 삭제 성공 메시지
*/
@DeleteMapping("/{uuid}")
public ResponseEntity<Void> deleteAnimal(@PathVariable String uuid) {
Long id = animalService.getAnimalByUuid(uuid);
animalService.deleteZoo(id);
return ResponseEntity.noContent().build();
}
/**
* 동물 검색 (페이징)
*
* @param name 동물 이름 (선택)
* @param category 서식지 타입 (선택)
* @param species 동물종 (선택) 개, 고양이등.
* @param page 페이지 번호 (기본값: 0)
* @param size 페이지 크기 (기본값: 20)
* @param sort 정렬 조건 (예: "name,asc")
* @return 페이징 처리된 동물 목록
*/
@GetMapping
public ResponseEntity<Page<AnimalDto.Basic>> searchAnimals(
@RequestParam(required = false) String name,
@RequestParam(required = false) Category category,
@RequestParam(required = false) Species species,
@RequestParam(defaultValue = "0") int page,
@RequestParam(defaultValue = "20") int size,
@RequestParam(required = false) String sort) {
AnimalDto.SearchReq searchReq =
new AnimalDto.SearchReq(name, category, species, page, size, sort);
Page<AnimalDto.Basic> animals = animalService.search(searchReq);
return ResponseEntity.ok(animals);
}
}

View File

@@ -0,0 +1,129 @@
package com.kamco.cd.kamcoback.zoo.dto;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.kamco.cd.kamcoback.config.enums.EnumType;
import java.time.ZonedDateTime;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
public class AnimalDto {
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public static class AddReq {
private Category category;
private Species species;
private String name;
}
@Getter
public static class Basic {
@JsonIgnore private Long id;
private String uuid;
private Category category;
private Species species;
private String name;
@JsonFormat(
shape = JsonFormat.Shape.STRING,
pattern = "yyyy-MM-dd'T'HH:mm:ssXXX",
timezone = "Asia/Seoul")
private ZonedDateTime createdDate;
@JsonFormat(
shape = JsonFormat.Shape.STRING,
pattern = "yyyy-MM-dd'T'HH:mm:ssXXX",
timezone = "Asia/Seoul")
private ZonedDateTime modifiedDate;
public Basic(
Long id,
String uuid,
String name,
Category category,
Species species,
ZonedDateTime createdDate,
ZonedDateTime modifiedDate) {
this.id = id;
this.uuid = uuid;
this.name = name;
this.category = category;
this.species = species;
this.createdDate = createdDate;
this.modifiedDate = modifiedDate;
}
}
@Getter
@AllArgsConstructor
public enum Category implements EnumType {
// @formatter:off
MAMMALS("100", "포유류"), // 땅에 사는 동물
BIRDS("200", "조류"), // 하늘을 나는 동물
FISH("300", "어류"),
AMPHIBIANS("400", "양서류"),
REPTILES("500", "파충류"),
INSECTS("500", "곤충"),
INVERTEBRATES("500", "무척추동물"),
;
// @formatter:on
private final String id;
private final String text;
}
@Getter
@AllArgsConstructor
public enum Species implements EnumType {
// @formatter:off
DOG("101", ""),
CAT("102", "강아지"),
DOVE("201", "비둘기"),
EAGLE("202", "독수리"),
SALMON("301", "연어"),
TUNA("302", "참치"),
;
// @formatter:on
private final String id;
private final String text;
}
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public static class SearchReq {
// 검색 조건
private String name;
private Category category;
private Species species;
// 페이징 파라미터
private int page = 0;
private int size = 20;
private String sort;
public Pageable toPageable() {
if (sort != null && !sort.isEmpty()) {
String[] sortParams = sort.split(",");
String property = sortParams[0];
Sort.Direction direction =
sortParams.length > 1
? Sort.Direction.fromString(sortParams[1])
: Sort.Direction.ASC;
return PageRequest.of(page, size, Sort.by(direction, property));
}
return PageRequest.of(page, size);
}
}
}

View File

@@ -0,0 +1,61 @@
package com.kamco.cd.kamcoback.zoo.service;
import com.kamco.cd.kamcoback.postgres.core.AnimalCoreService;
import com.kamco.cd.kamcoback.zoo.dto.AnimalDto;
import lombok.RequiredArgsConstructor;
import org.springframework.data.domain.Page;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@RequiredArgsConstructor
@Service
@Transactional(readOnly = true)
public class AnimalService {
private final AnimalCoreService zooCoreService;
// 동물의 UUID로 id조회
public Long getAnimalByUuid(String uuid) {
return zooCoreService.getDataByUuid(uuid).getId();
}
/**
* 동물 생성
*
* @param req 동물 생성 요청
* @return 생성된 동물 정보
*/
@Transactional
public AnimalDto.Basic createAnimal(AnimalDto.AddReq req) {
return zooCoreService.create(req);
}
/**
* 동물 삭제 (논리 삭제)
*
* @param id 동물 ID
*/
@Transactional
public void deleteZoo(Long id) {
zooCoreService.remove(id);
}
/**
* 동물 단건 조회
*
* @param id 동물 ID
* @return 동물 정보
*/
public AnimalDto.Basic getAnimal(Long id) {
return zooCoreService.getOneById(id);
}
/**
* 동물 검색 (페이징)
*
* @param searchReq 검색 조건
* @return 페이징 처리된 동물 목록
*/
public Page<AnimalDto.Basic> search(AnimalDto.SearchReq searchReq) {
return zooCoreService.search(searchReq);
}
}