[SpringBoot] Swagger Controller 분리

Controller에 Swagger 작업을 진행하면 매우 지저분해진다.

보다 깔끔하게 작성할 수 있는 방법은 아래와 같이 Docs 인터페이스를 만들어서 분리해 주면 된다.

 

@RequiredArgsConstructor
@RequestMapping("/api/v1/coins")
@RestController
public class CoinController implements CoinControllerDocs {

    private final CoinService coinService;

    @GetMapping("/{coinId}")
    public ResponseEntity<GetUpbitCoinResponseDto> get(@PathVariable Long coinId) {
        GetUpbitCoinResponseDto responseDto = coinService.get(coinId);
        return ResponseEntity.ok(responseDto);
    }

    @GetMapping
    public ResponseEntity<ListUpbitCoinResponseDto> gets() {
        ListUpbitCoinResponseDto responseDto = coinService.gets();
        return ResponseEntity.ok(responseDto);
    }

    @GetMapping("/search")
    public ResponseEntity<ListUpbitCoinResponseDto> search(@RequestParam String query) {
        ListUpbitCoinResponseDto responseDto = coinService.search(query);
        return ResponseEntity.ok(responseDto);
    }
}

@Tag(name = "암호화폐", description = "암호화폐 관련 API")
public interface CoinControllerDocs {

    @Operation(summary = "암호화폐 정보 조회 기능", description = "암호화폐 정보 조회 API")
    ResponseEntity<GetUpbitCoinResponseDto> get(@PathVariable Long coinId);

    @Operation(summary = "암호화폐 목록 조회 기능", description = "암호화폐 목록 조회 API")
    ResponseEntity<ListUpbitCoinResponseDto> gets();

    @Operation(summary = "암호화폐 검색 기능", description = "암호화폐 검색 API")
    ResponseEntity<ListUpbitCoinResponseDto> search(@RequestParam String query);
}