REST API 구현

@RestController
@RequestMapping("/api/orders")
@RequiredArgsConstructor
public class OrderController {

    private final OrderService orderService;

    @GetMapping("/{orderId}")
    public OrderResponse getOrder(@PathVariable Long orderId) {
        return orderService.findOne(orderId);
    }

    @GetMapping
    public List<OrderResponse> getOrders(@RequestParam(defaultValue = "ALL") String status) {
        return orderService.findAll(status);
    }

    @PostMapping
    public ResponseEntity<OrderResponse> create(@RequestBody OrderCreateRequest request) {
        OrderResponse created = orderService.create(request);
        return ResponseEntity
                .created(URI.create("/api/orders/" + created.id()))
                .body(created);
    }
}

클래스에 @RequestMapping으로 공통 경로를 두고 메서드에서 나머지를 적습니다. 생성 요청은 201과 Location 헤더를 함께 돌려주는 것이 규약입니다.

// 요청: 클라이언트가 보낼 수 있는 값만 정의합니다
public record OrderCreateRequest(
        @NotNull Long memberId,
        @NotEmpty List<OrderLineRequest> lines,
        @Size(max = 200) String memo
) {
}

// 응답: 외부에 보여줄 값만 정의합니다
public record OrderResponse(
        Long id,
        String status,
        int totalAmount,
        LocalDateTime orderedAt
) {
    public static OrderResponse from(Order order) {
        return new OrderResponse(
                order.getId(),
                order.getStatus().name(),
                order.getTotalAmount(),
                order.getOrderedAt()
        );
    }
}

엔티티에서 DTO로 바꾸는 변환 메서드를 DTO 쪽에 두면 엔티티가 표현 계층을 몰라도 됩니다.

@PostMapping
public ResponseEntity<OrderResponse> create(
        @Valid @RequestBody OrderCreateRequest request) {
    // 여기 도달했다면 형식 검증은 이미 통과한 상태입니다
    return ResponseEntity.ok(orderService.create(request));
}

// 쿼리 파라미터를 검증하려면 클래스에 @Validated가 필요합니다
@Validated
@RestController
public class OrderController {

    @GetMapping
    public List<OrderResponse> getOrders(
            @RequestParam @Positive int page) {
        return orderService.findAll(page);
    }
}