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

[BE] [15-01] Swagger 적용 #97

Merged
merged 6 commits into from
Nov 17, 2023

Conversation

SongJSeop
Copy link
Collaborator

📎 이슈번호

#96 [15-01] Api들에 Swagger 설정을 적용한다.

📃 변경사항

  • Swagger 패키지 설치
  • main.ts에 Swagger 설정 추가
  • Board 모듈 Api, Dto에 Swagger 데코레이터 추가
  • Auth 모듈 Api, Dto에 Swagger 데코레이터 추가

📌 중점적으로 볼 부분

🎇 동작 화면

만들어진 Swagger UI

localhost:3000/api로 들어가면 들어가짐
image
image

💫 기타사항

- @nestjs/swagger 패키지 설치
- main.ts에 swagger 설정 추가
- swagger 문서 생성
- swagger ui 설정
- BoardController 라우터들에 Swagger 데코레이터들 추가
- CreateBoardDto에 Swagger 데코레이터 추가
- BoardController의  Swagger 데코레이터들 응답에 맞는 데코레이터로 수정
- AuthController의 Api들에 Swagger Decorator들 추가
- SignUpUserDto, SignInUserDto에 Swagger Decorator들 추가
@SongJSeop SongJSeop added ✨ Feature 기능 개발 BE 백엔드 labels Nov 16, 2023
@SongJSeop SongJSeop added this to the Week 2 milestone Nov 16, 2023
@SongJSeop SongJSeop requested a review from qkrwogk November 16, 2023 15:35
@SongJSeop SongJSeop self-assigned this Nov 16, 2023
Copy link
Collaborator

@qkrwogk qkrwogk left a comment

Choose a reason for hiding this comment

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

페어 프로그래밍 끝나고도 PR을 날려주신 엄청난 준섭님 너무 고생 많으셨습니다.. 짱짱 ㅠㅠ👍

지금은 안돼있지만 유효성 검증 해서 실제로 에러 처리를 해야겠다고 생각하는 부분에는 ⭐️ 표시,
추후에 삭제하는게 좋을 것 같다는 의견에는 ❗️ 표시 해두었습니다.

다음 페어프로그래밍때 기능 구현 끝내고 다시 보면 좋을 것 같아요 기능에 문제있는게 아니니 바로 승인 하겠습니다 안녕히 주무셔요!!

@qkrwogk qkrwogk merged commit 17432c4 into boostcampwm2023:be-develop Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BE 백엔드 ✨ Feature 기능 개발
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants