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

[BE] docs: Swagger API 문서 업데이트 #313

Merged
merged 14 commits into from
Aug 12, 2024
Merged

[BE] docs: Swagger API 문서 업데이트 #313

merged 14 commits into from
Aug 12, 2024

Conversation

Kimprodp
Copy link
Contributor

🚀 어떤 기능을 구현했나요 ?

  • 변경된 도메인 구조 설계에 맞게 Swagger API 문서를 업데이트 했습니다.

🔥 어떻게 해결했나요 ?

  • dto와 controller에 Swagger 어노테이션을 붙였죠

📝 어떤 부분에 집중해서 리뷰해야 할까요?

  • api 문서 확인해주세요.

📚 참고 자료, 할 말

  • 눈 아프네요 빨리 api 문서 어떤식으로 할지 정해야 할듯
  • ps. dto 컨벤션도 ..

Kimprodp added 12 commits August 12, 2024 14:49
@Kimprodp
refactor: dto 생성 로직의 에러 수정
b14a9e5
@Kimprodp
docs: 리뷰 폼 응답 dto에 Swagger 어노테이션 추가
9c65cf9
@Kimprodp
docs: 리뷰 폼 응답 컨트롤러에 Swagger 어노테이션 추가
e18f5ff
@Kimprodp
docs: swagger examples 제외
c022de8
@Kimprodp
docs: 리뷰 쓰기 요청 dto에 Swagger 어노테이션 추가
2b91baf
@Kimprodp
docs: 리뷰 쓰기 요청 컨트롤러에 Swagger 어노테이션 추가
711a610
@Kimprodp
docs: api 문서 버전 표시
d00bf75
@Kimprodp
docs: TemplateResponse dto api description 명칭 통일
f692c2b
@Kimprodp
docs: 받은 리뷰 목록 조회 응답 dto에 Swagger 어노테이션 추가
aba0808
@Kimprodp
docs: 받은 리뷰 목록 조회 응답 컨트롤러 Swagger 어노테이션 추가
3276fc1
@Kimprodp
docs: 리뷰 상세 조회 조회 응답 dto Swagger 어노테이션 추가
11d5a16
@Kimprodp
docs: 리뷰 상세 조회 조회 응답 컨트롤러 Swagger 어노테이션 추가
1940efe
@Kimprodp Kimprodp added this to the 4차 스프린트: 최종 milestone Aug 12, 2024
@Kimprodp Kimprodp self-assigned this Aug 12, 2024
@Kimprodp Kimprodp linked an issue Aug 12, 2024 that may be closed by this pull request
[BE] 구현된 내용으로 Swagger API 문서를 업데이트 한다. (v2) #306
Closed
@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 12, 2024 •
edited
Loading

Test Results

57 tests  ±0   57 ✅ ±0   2s ⏱️ ±0s
22 suites ±0    0 💤 ±0 
22 files   ±0    0 ❌ ±0 

Results for commit c92c011. ± Comparison against base commit 0eda785.

♻️ This comment has been updated with latest results.

donghoony
donghoony approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@donghoony donghoony left a comment

Choose a reason for hiding this comment

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

스웨거 슬슬 아니다 싶네요 🤔 테드 고생했습니다! Json 깊이 깊어지면 어떤 식으로 하면 좋을지 생각 진짜 해봐야겠어요.

skylar1220
skylar1220 approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@skylar1220 skylar1220 left a comment

Choose a reason for hiding this comment

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

스웩있네요~

@Kimprodp
Merge remote-tracking branch 'refs/remotes/origin/develop' into be/do…
44e1ee5 
…cs/306-swagger-api-update-v2

# Conflicts:
#	backend/src/main/java/reviewme/template/service/TemplateMapper.java
@Kimprodp
Merge remote-tracking branch 'refs/remotes/origin/develop' into be/do…
c92c011 
…cs/306-swagger-api-update-v2

# Conflicts:
#	backend/src/main/java/reviewme/review/service/dto/response/detail/QuestionAnswerResponse.java
donghoony
donghoony approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@donghoony donghoony left a comment

Choose a reason for hiding this comment

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

어어어 푸푸푸 또 허허허 우우우적

skylar1220
skylar1220 approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@skylar1220 skylar1220 left a comment

Choose a reason for hiding this comment

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

찐최종마지막

@Kimprodp Kimprodp merged commit 40188a2 into develop Aug 12, 2024
4 of 5 checks passed
@donghoony donghoony deleted the be/docs/306-swagger-api-update-v2 branch August 20, 2024 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@donghoony donghoony donghoony approved these changes

@nayonsoso nayonsoso nayonsoso approved these changes

@skylar1220 skylar1220 skylar1220 approved these changes

Assignees

@Kimprodp Kimprodp

Labels
✨ BE 📋 문서 🫠 힘들다...
Projects
2024-review-me
Status: Done
Milestone
4차 스프린트: 최종
Development

Successfully merging this pull request may close these issues.

[BE] 구현된 내용으로 Swagger API 문서를 업데이트 한다. (v2)
4 participants
@Kimprodp @donghoony @nayonsoso @skylar1220