Skip to content

docs: PageMeta에 example 명시해 Swagger 의미없는 샘플값 제거 - #218

Merged
sjungwon03 merged 1 commit into
devfrom
docs/217-pagemeta-swagger-example
Jul 24, 2026
Merged

docs: PageMeta에 example 명시해 Swagger 의미없는 샘플값 제거#218
sjungwon03 merged 1 commit into
devfrom
docs/217-pagemeta-swagger-example

Conversation

@sjungwon03

Copy link
Copy Markdown
Member

변경 내용

  • global.common.PageMetapage/totalCount/totalPages@Schema(description, example) 추가

배경

Swagger UI에서 페이지네이션 응답의 meta{"page": 1073741824, "totalCount": 9007199254740991, "totalPages": 1073741824}처럼 의미 없는 값으로 표시되는 문제. 실제 응답 데이터가 아니라, int/long 필드에 example이 없으면 Swagger UI 내부 샘플러(openapi-sampler)가 채워 넣는 기본 placeholder(각각 2^30, 2^53-1)였다.

검증

  • ./gradlew spotlessApply./gradlew compileJava./gradlew test spotlessCheck 모두 통과
  • 로컬 기동 후 /v3/api-docs에서 PageMeta 스키마 확인 — page: 1, totalCount: 42, totalPages: 5로 정상 노출

연결 이슈

Closes #217

int/long 필드에 example이 없으면 Swagger UI 샘플러가 2^30,
2^53-1(Number.MAX_SAFE_INTEGER) 같은 의미 없는 기본값을
채워 넣는다. @Schema(example=...)로 실제 값처럼 보이는
예시를 명시한다.

Closes #217
@sjungwon03 sjungwon03 added the docs 문서 작성 label Jul 24, 2026
@sjungwon03 sjungwon03 self-assigned this Jul 24, 2026
@sjungwon03
sjungwon03 requested a review from myh7754 July 24, 2026 08:07
@kilo-code-bot

kilo-code-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 files)
  • src/main/java/com/bop/youthpick/global/common/PageMeta.java

Reviewed by step-3.7-flash · Input: 72.8K · Output: 1.5K · Cached: 91.4K

@sjungwon03
sjungwon03 merged commit 53471de into dev Jul 24, 2026
2 checks passed
@sjungwon03
sjungwon03 deleted the docs/217-pagemeta-swagger-example branch July 24, 2026 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서 작성

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: PageMeta에 example 명시해 Swagger 의미없는 샘플값 제거

1 participant