전남대 BE_나제법 5주차(3단계)

[nove1080]

API 문서 위치

API 명세서는 resources/static/docs.html 에 모두 기록되어 있습니다!

과제를 진행하며 어려웠던 점

1. 쿼리파라미터만 추가된 엔드포인트 대해 테스트가 수행되지 않습니다

@RestController
@RequestMapping("/api/products")
public class ProductApiController {

    @GetMapping
    public ResponseEntity<ReadAllProductsResponse> readAllProducts(@PageableDefault Pageable pageable) {
        ReadAllProductsResponse response = productService.readAllProducts(pageable);
        return ResponseEntity.ok(response);
    }
    
    @GetMapping(params = "categoryId")
    public ResponseEntity<ReadAllProductsResponse> readAllProductsByCategoryId(@PageableDefault Pageable pageable, @RequestParam Long categoryId) {
        ReadAllProductsResponse response = productService.readAllProductsByCategoryId(categoryId, pageable);
        return ResponseEntity.ok(response);
    }
    
}

categoryId 를 쿼리파라미터로 받는 엔드포인트(readAllProductsByCategoryId)에 대해서 요청을 보내면 readAllProducts 여기로 요청이 나가는 것 같습니다. 무슨 문제인지 잘 모르겠습니다 이 문제를 스스로 해결하지 못해서 아직 /api/products?categoryId 명세를 작성하지 못하였습니다. (ProductApiControllerTest에 주석 처리하였습니다) 스스로 해결하지 못할 것 같아 이 문제에 대해 멘토님의 조언을 듣고 싶습니다.

궁금한 점

1. 어노테이션을 붙이는 순서도 나름의 기준이 있나요?

@ActiveProfiles("test")
@SpringBootTest
@Import(RestDocsConfiguration.class)
@ExtendWith(RestDocumentationExtension.class)
class MemberApiControllerTest {}

위와 같이 여러 어노테이션이 붙게 되는 경우 어노테이션을 붙이는 순서(어떤 어노테이션이 더 위에 있고 밑에 있는지)도 나름의 기준이 있나요? 멘토님의 생각이 궁금합니다

2. 컨트롤러 테스트 코드에 대한 피드백을 받고 싶습니다

Mockito를 사용한 테스트를 하는게 익숙하지 않아 개선할 부분을 알려주시면 많은 도움이 될 것 같습니다!

3. 실무에서는 어떻게 API 명세서를 관리하나요?

동건님 덕분에 몰랐던 부분도 많이 알게되고 재밌게 공부하고 있습니다 항상 감사합니다!!!