Springdoc을 이용한 응답 예제값 설정 및 문서화 추가

[limehee]

Describe

현재 프로젝트에서는 Springdoc(Swagger)을 통해 API 문서화를 진행하고 있지만, 응답(Response)에 대한 예제값 설정(example values)이 문서에 누락되어 있습니다. 이로 인해 API 사용자가 응답 형식을 명확히 이해하지 못하거나, 클라이언트 측에서 요청 결과를 올바르게 처리하는 데 어려움이 발생할 수 있습니다. API의 가독성과 사용성을 개선하기 위해, 응답 예제값을 설정하고 문서화에 반영해야 합니다.

Tasks

1. 응답 DTO에 예제값 추가

• @Schema 또는 @ApiModelProperty 애너테이션을 활용하여 응답 DTO 필드에 적절한 예제값을 설정합니다.
• 예제값은 비즈니스 로직과 실제 응답 데이터를 기반으로 작성합니다.

2. Swagger UI에서 예제값 확인

• Springdoc에서 제공하는 @ExampleObject 또는 @ApiResponse를 활용하여, API의 응답 샘플을 Swagger UI에 명시합니다.
• 복잡한 응답 형식(JSON 포함)에 대한 샘플을 추가하여 이해를 돕습니다.

3. 공통 응답 형식 정의

• 프로젝트 내에서 사용하는 공통 응답 DTO(ApiResponse, PagedResponseDto 등)에 대해 예제값을 설정합니다.
• 공통적인 성공/실패 응답 형식에 대한 샘플을 작성하여 일관성을 유지합니다.