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

[DOCS] Swagger 상세 설정 (Payment, Subscription) #132

Merged
merged 5 commits into from
Aug 17, 2024

Conversation

eunsol-an
Copy link
Member

@eunsol-an eunsol-an commented Aug 13, 2024

PR 타입

반영 브랜치

feature/swagger → develop

작업 사항

  • Payment와 Subscription의 Swagger 상세 설정을 하였습니다.
    • @Content를 이용하여 responseBody로 제공될 클래스의 Class 타입을 지정하려 했으나, implementation에서는 Class literal 타입만 취급하여 기존 BaseResponse로 통일했던 response 타입을 변경해주었습니다.
    • @Schema를 이용해 Payment request의 상세 설명을 추가하였습니다.

체크리스트

  • 빌드에 성공했나요?
  • 코드 컨벤션을 잘 지켰나요? (cmd + opt + L)

테스트 결과

이상 없습니다.
추후 모든 Controller에 대한 Swagger 상세 설정이 필요합니다.

@eunsol-an eunsol-an added the 📝documentation Improvements or additions to documentation label Aug 13, 2024
@eunsol-an eunsol-an requested a review from im-gnar August 13, 2024 14:52
@eunsol-an eunsol-an self-assigned this Aug 13, 2024
Copy link
Collaborator

@im-gnar im-gnar left a comment

Choose a reason for hiding this comment

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

짱입니다요~~👍

@eunsol-an eunsol-an merged commit 4e6e108 into develop Aug 17, 2024
@eunsol-an eunsol-an deleted the feature/swagger branch August 19, 2024 13:06
@eunsol-an eunsol-an mentioned this pull request Sep 7, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants