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

[feat] Rest Docs와 Swagger를 연결하여 사용하여 문서화 작업을 실행한다. #14

Merged
merged 12 commits into from
Oct 17, 2024

Conversation

juuuunny
Copy link
Contributor

@juuuunny juuuunny commented Oct 15, 2024

✅ PR 유형

어떤 변경 사항이 있었나요?

  • 새로운 기능 추가
  • 버그 수정
  • 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
  • 코드 리팩토링
  • 주석 추가 및 수정
  • 문서 수정
  • 빌드 부분 혹은 패키지 매니저 수정
  • 파일 혹은 폴더명 수정
  • 파일 혹은 폴더 삭제

📝 작업 내용

이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

  • Rest Docs를 테스트하는 API를 만든다.
  • 위의 테스트 API에 대한 테스트 코드를 작성한다.
  • Rest Docs와 Swagger 연결 설정을 한다.
스크린샷 2024-10-15 오후 11 16 08

✏️ 관련 이슈

본인이 작업한 내용이 어떤 Issue Number와 관련이 있는지만 작성해주세요

ex)


🎸 기타 사항 or 추가 코멘트

@juuuunny juuuunny self-assigned this Oct 15, 2024
@juuuunny juuuunny added 🚀 feat 새로운 기능 추가 / 일부 코드 추가 / 일부 코드 수정 (리팩토링과 구분) / 디자인 요소 수정 ⚒️ chore 빌드 부분 혹은 패키지 매니저 수정 사항 😆 JUNHYEONG 준형 Issue or PR labels Oct 15, 2024
Copy link
Contributor Author

Choose a reason for hiding this comment

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

아 이거 gitignore에 넣어야 하는데 깜빡했네

Copy link
Contributor Author

Choose a reason for hiding this comment

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

추가적으로 swagger에 반영하고 싶다면
./gradlew build를 통해서 빌드를 하고 실행을 시키면
http://localhost:8080/docs/swagger-ui/index.html#/ 에서 확인할 수 있습니다

Copy link
Contributor

@bbbang105 bbbang105 left a comment

Choose a reason for hiding this comment

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

굿굿 너무 고생많으셨습니다! 👍🏻
저도 아직 잘 몰라서 pull 받고 계속 해볼게요

@juuuunny juuuunny merged commit 38a8a91 into develop Oct 17, 2024
1 check passed
@juuuunny juuuunny deleted the feature/#13/rest-docs branch October 17, 2024 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚒️ chore 빌드 부분 혹은 패키지 매니저 수정 사항 🚀 feat 새로운 기능 추가 / 일부 코드 추가 / 일부 코드 수정 (리팩토링과 구분) / 디자인 요소 수정 😆 JUNHYEONG 준형 Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feat] RestDocs를 도입하여 문서화 작업을 한다.
2 participants