Skip to content

[Feat] Swagger Docs에 @Parameter로 상세 설명 추가#175

Open
kangyeson wants to merge 1 commit intoLeets-Official:강예손/mainfrom
kangyeson:강예손/5주차

Hidden character warning

The head ref may contain hidden characters: "\uac15\uc608\uc190/5\uc8fc\ucc28"
Open

[Feat] Swagger Docs에 @Parameter로 상세 설명 추가#175
kangyeson wants to merge 1 commit intoLeets-Official:강예손/mainfrom
kangyeson:강예손/5주차

Conversation

@kangyeson
Copy link
Copy Markdown

1. 과제 요구사항 중 구현한 내용

  • 기존에 구현 중인 서버 프로젝트에 Swagger를 추가한다.
  • 실행 후 Swagger UI 페이지에 접속할 수 있어야 한다.
  • 현재 프로젝트에 구현되어 있는 API가 Swagger 문서에 표시되어야 한다.
  • 문서를 보고 각 API의 요청 방식과 URL, 요청값, 응답값을 확인할 수 있어야 한다.

2. 핵심 변경 사항

기존 Swagger 문서화 Docs 코드에 @parameter 어노테이션으로 상세 설명 추가

3. 실행 및 검증 결과

  • 실행 결과:
image
  • API 요청 응답 테스트:
image
  • 예외 상황 문서화:
image

4. 완료 사항

  1. Swagger 문서화 코드 추가
  2. 상세 설명 및 예시값 추가

5. 추가 사항

  • 관련 이슈: closed #174

제출 체크리스트

  • PR 제목이 규칙에 맞다
  • base가 {이름}/main 브랜치다
  • compare가 {이름}/{숫자}주차 브랜치다
  • 프로젝트가 정상 실행된다
  • 본인을 Assignee로 지정했다
  • 파트 담당 Reviewer를 지정했다
  • 리뷰 피드백을 반영한 뒤 머지/PR close를 진행한다

Reviewer 참고

@kangyeson kangyeson requested a review from a team May 2, 2026 19:22
@kangyeson kangyeson self-assigned this May 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant