Skip to content

[Feature] 스웨거 예시 데이터 추가하기 #199

Description

@Yithian01

📑 기능 설명

Swagger 문서에 API 요청/응답 예시 데이터를 추가합니다.
로그인 계정 API와 같이, 클라이언트 개발자가 쉽게 참고할 수 있도록 각 API별 예시(JSON Request/Response)를 작성하여 Swagger에 반영합니다.

✅ 작업할 내용

  • Swagger 설정에 Example 추가 기능 적용
  • 로그인 API 요청/응답 예시 데이터 작성
  • 회원가입, 아이템 등록, 경매, 게임 진행 API 등 주요 API 예시 데이터 추가
  • DTO 클래스에 @Schema(example = "...") 적용
  • 공통 응답 포맷(success, message, data)에 대한 Swagger 예시 정의

🎈 기대 효과

  • 클라이언트 개발자가 Swagger에서 실제 요청/응답 구조를 직관적으로 확인 가능
  • API 테스트 및 연동 시 개발 편의성 향상
  • 문서 가독성 및 신뢰성 강화

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions