Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[global] swagger 적용 #112

Merged
merged 14 commits into from
Aug 8, 2024
Merged

[global] swagger 적용 #112

merged 14 commits into from
Aug 8, 2024

Conversation

tlsgmltjd
Copy link
Member

@tlsgmltjd tlsgmltjd commented Aug 4, 2024

개요

swagger를 적용하였습니다.

본문

  • /member/**, /oneseo/**, /auth/** path와 매핑되는 API를 swagger 문서에 등록하였습니다.
  • 컨트롤러에 @Tag 추가, 각각의 컨트롤러 메서드에 @Operation을 추가하여 컨트롤러 설명을 추가하였습니다.
  • /api-docs path 에 대한 response를 commonResponse 로 wrapping 하지 않도록 제외하였습니다.
  • commonResponse 객체에서 data필드가 있는 경우와 없는 경우의 분기를 설정해서 문서에 표시되도록 설정하였습니다.
  • @authrequest memberId가 문서에 파라미터로 표시되는 문제가 있어서 SwaggerConfig의 설정을 통해 제외하였습니다.
  • 원서 생성과 수정에 관련된 dto에 Schema 설정을 하여 문서 이해를 쉽게 하였습니다.

@tlsgmltjd tlsgmltjd added feature 새로운 기능 추가 priority: high 우선순위 높음 labels Aug 4, 2024
@tlsgmltjd tlsgmltjd self-assigned this Aug 4, 2024
@tlsgmltjd tlsgmltjd marked this pull request as ready for review August 5, 2024 16:17
Copy link
Collaborator

@jangwooooo jangwooooo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수고하셨습니다 👍

@tlsgmltjd tlsgmltjd merged commit 3e6d364 into develop Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 새로운 기능 추가 priority: high 우선순위 높음
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants