Spring Rest Docs request에 List 타입이 포함된 경우

• 학습 관련 질문을 남겨주세요. 어떤 부분이 고민인지, 무엇이 문제인지 상세히 작성하면 더 좋아요!

• 먼저 유사한 질문이 있었는지 검색해 보세요.

• 서로 예의를 지키며 존중하는 문화를 만들어가요.

   

 안녕하세요. 강의 너무 잘 듣고 있습니다! 현재까지 진행해온 프로젝트의 OrderController에도 Spring Rest Docs를 적용해보는 와중에 몇가지 질문이 생겼습니다!

public class OrderControllerDocsTest extends RestDocsSupport {

    private final OrderService orderService = mock(OrderService.class);
    private static List<ProductResponse> productResponses;

    @Override
    protected Object initController() {
        return new OrderController(orderService);
    }

    @BeforeEach
    void init() throws Exception {
        ProductResponse productResponse1 = ProductResponse.builder()
                .id(1L)
                .price(1000)
                .sellingStatus(SELLING)
                .productNumber("001")
                .type(HANDMADE)
                .name("상품명1")
                .build();

        ProductResponse productResponse2 = ProductResponse.builder()
                .id(2L)
                .price(3000)
                .sellingStatus(SELLING)
                .productNumber("002")
                .type(HANDMADE)
                .name("상품명2")
                .build();

        productResponses = List.of(productResponse1, productResponse2);
    }

    @DisplayName("새로운 주문을 생성한다.")
    @Test
    void createOrder() throws Exception {
        //given
        LocalDateTime now = LocalDateTime.of(2025, 1, 28, 0, 50);
        List<String> productNumbers = List.of("001", "002");
        OrderCreateRequest request = OrderCreateRequest.builder()
                .productNumbers(productNumbers)
                .build();
        int totalPrice = productResponses.stream().mapToInt(ProductResponse::getPrice).sum();

        OrderResponse orderResponse = OrderResponse.builder()
                .id(1L)
                .registeredDateTime(now)
                .products(productResponses)
                .totalPrice(totalPrice)
                .build();

        given(orderService.createOrder(any(OrderCreateServiceRequest.class), any(LocalDateTime.class)))
                .willReturn(orderResponse);
        //when
        mockMvc.perform(post("/api/v1/orders/new")
                .content(mapper.writeValueAsString(request))
                .contentType(MediaType.APPLICATION_JSON))
                .andDo(print())
                .andExpect(status().isOk())
                .andDo(document("order-create",
                        preprocessRequest(prettyPrint()), // adoc에서 json 형태를 보기 좋게 만들어줌
                        preprocessResponse(prettyPrint()),
                        requestFields(
                                fieldWithPath("productNumbers").type(JsonFieldType.ARRAY)
                                        .description("상품 리스트")
                        ),
                        responseFields(
                                fieldWithPath("code").type(JsonFieldType.NUMBER)
                                        .description("코드"),
                                fieldWithPath("status").type(JsonFieldType.STRING)
                                        .description("상태"),
                                fieldWithPath("message").type(JsonFieldType.STRING)
                                        .description("메시지"),
                                fieldWithPath("data").type(JsonFieldType.OBJECT)
                                        .description("응답 데이터"),
                                fieldWithPath("data.id").type(JsonFieldType.NUMBER)
                                        .description("주문 ID"),
                                fieldWithPath("data.totalPrice").type(JsonFieldType.NUMBER)
                                        .description("총 주문 가격"),
                                fieldWithPath("data.registeredDateTime").type(JsonFieldType.ARRAY) // 반환타입 ARRAY ?
                                        .description("주문 시간"),
                                fieldWithPath("data.products").type(JsonFieldType.ARRAY)
                                        .description("주문 상품 리스트"),
                                fieldWithPath("data.products[].id").type(JsonFieldType.NUMBER)
                                        .description("주문 상품 ID"),
                                fieldWithPath("data.products[].productNumber").type(JsonFieldType.STRING)
                                        .description("주문 상품 번호"),
                                fieldWithPath("data.products[].type").type(JsonFieldType.STRING)
                                        .description("주문 상품 타입"),
                                fieldWithPath("data.products[].sellingStatus").type(JsonFieldType.STRING)
                                        .description("주문 상품 상태"),
                                fieldWithPath("data.products[].name").type(JsonFieldType.STRING)
                                        .description("주문 상품명"),
                                fieldWithPath("data.products[].price").type(JsonFieldType.NUMBER)
                                        .description("주문 상품 가격")

                        ))
                );
    }
}

1. OrderService.createOrder() 메서드 반환 값 OrderResponse를 생성하기 위해선 ProductResponse 객체가 필요합니다. 이러한 경우가 강사님이 말씀하신 @BeforeEach의 적용시점인가? 라는 생각이 들어 위와 같이 작성해봤습니다. 제가 이해한 바가 맞을까요??
   

2.  

   requestFields(
                                   fieldWithPath("productNumbers").type(JsonFieldType.ARRAY)
                                           .description("상품 리스트")
                           ),

   위 코드에서 productNumbers에 있는 각 원소의 타입이 String 인것을 API 문서에 나타내고 싶어 fieldWithPath("productNumbers[]").type(JsonFieldType.STRING과 같이 작성해봤지만 타입 미스매칭 오류가 발생했습니다. responseFields에는 동일한 방법으로 List 순회에 성공했지만 requestFields 순회 문제는 해결하지 못했습니다.
   혹시 방법이 있다면 알려주시면 감사하겠습니다!