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.

Sign up for GitHub

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

Jump to bottom

[#013] Swagger 설정 #84

Merged
merged 21 commits into from
Apr 19, 2024
Merged

[#013] Swagger 설정 #84

merged 21 commits into from
Apr 19, 2024

Conversation

koomin1227
Copy link
Member

이슈

체크리스트

  • Swagger 설정
  • B 구현

고민한 내용

  • api 기능을 변경할 때마다 매번 swagger 허브에 있는 yaml 파일을 바꾸는 것이 힘들었다. 또한 바꾼다 한들 실수로 누락되는 부분이 있었고 동기화 관리가 어려워서 프로젝트에 자동으로 swagger 문서를 생성 하도록 적용했다.

요구사항

  • 패치받아서 직접 실행해서 오류가 없는지 문서를 확인해주세요.
  • /api 로 들어가면 보입니다.

@koomin1227
Deps: swagger 모듈 설치
45ae03f
@koomin1227
Feat: swagger 문서 설정
feb179f
@koomin1227
Feat: 각 api들에 태그 달기
e55ad33
@koomin1227
Feat: swagger 문서에 BearerAuth 추가
c32586e
@koomin1227
Feat: Get /api/users/{id} swagger 문서 추가
76c2fe5
@koomin1227
Feat: Put /api/users/{id} swagger 문서 추가
9972ced
@koomin1227
Feat: Delete /api/users/{id} swagger 문서 추가
35bb546
@koomin1227
Feat: Get /api/stat/{id} swagger 문서 추가
7c9bad2
@koomin1227
Feat: Post /api/stat/algorithm swagger 문서 추가
c14d27a
@koomin1227
Feat: Post /api/stat/grade swagger 문서 추가
1ff34ad
@koomin1227
Feat: Patch /api/stat/algorithm swagger 문서 추가
9471e65
@koomin1227
Feat: Patch /api/stat/grade swagger 문서 추가
d1e5175
@koomin1227
Feat: Delete /api/stat/grade swagger 문서 추가
01a9eb0
@koomin1227
Feat: Delete /api/stat/algorithm swagger 문서 추가
3b2c254
@koomin1227
Feat: Post /api/stat/github swagger 문서 추가
beec487
@koomin1227
Feat: Delete /api/stat/github swagger 문서 추가
1ec0cfc
@koomin1227
Feat: Post /api/auth/apple swagger 문서 추가
b6ee575
@koomin1227
Feat: Post /api/auth/checkNickname swagger 문서 추가
af283e6
@koomin1227
Feat: Post /api/auth/refresh swagger 문서 추가
acedc5f
@koomin1227
Feat: Get /api/rank/algorithm swagger 문서 추가
ed6c113
@koomin1227 koomin1227 self-assigned this Apr 18, 2024
namewhat99
namewhat99 approved these changes Apr 19, 2024
View reviewed changes
Copy link
Contributor

@namewhat99 namewhat99 left a comment

Choose a reason for hiding this comment

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

확인했습니다~ 굳굳

@namewhat99 namewhat99 merged commit d2c533e into develop Apr 19, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@namewhat99 namewhat99 namewhat99 approved these changes

Assignees

@koomin1227 koomin1227

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@koomin1227 @namewhat99