Skip to content

Conversation

@hodadako
Copy link
Member

PR을 보내기 전에 확인해주세요!!

  • 컨벤션에 맞게 작성했습니다. 컨벤션 확인은 여기
  • 변경 사항에 대한 테스트를 했습니다.

관련 이슈

close: #157

개요

변경 사항에 대해 간단하게 작성해주세요. 무엇을 왜 수정했는지 설명해주세요.

  • 모든 컨트롤러 테스트 수정 및 rest docs 문서화 추가

상세 내용

  • Spring Rest Docs 설정 추가. 기본적인 방식은 build가 되면 test가 돌고 test가 돌면 build - generated-snippets에 문서 조각인 adoc이 생성되는데 이때 src/doc/에 해당 폴더와 이름이 같은 adoc이 존재하면 문서 조각을 하나의 adoc으로 만들어줍니다.
  • 이후 해당 adoc은 asciidoctor에 의해 html로 변경되어서 build/docs/asciidoc/ 하위에 html 형식으로 만들어지고 build.gradle 설정에 따라서 해당 파일을 build 된 jar 파일에 복사해줍니다.
  • 복사된 파일은 {domain}:{port}/docs/index.html로 접근 가능합니다.
  • 중요!!!!!! : test가 통과 될때만 문서 조각이 생성되므로 앞으로 controller test 수정 시에 무조건 테스트를 돌려보고 pr을 올려주세요.

@hodadako hodadako added Feature 기능 개발 Setting 개발 환경 세팅 Test test 관련 Refactor 코드 리팩토링 Documentation 문서화 labels Mar 19, 2024
@hodadako hodadako self-assigned this Mar 19, 2024
Copy link
Collaborator

@mooncw mooncw left a comment

Choose a reason for hiding this comment

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

고생하셨습니다.

@mooncw
Copy link
Collaborator

mooncw commented Mar 20, 2024

main 머지는 cd를 수정한 PR과 함께 할까요?

@mooncw mooncw merged commit 2e8f7c5 into develop Mar 20, 2024
@mooncw mooncw deleted the refactor#157-spring-rest-docs branch March 20, 2024 02:05
@mooncw
Copy link
Collaborator

mooncw commented Mar 20, 2024

이후 PR에 같이 수정할게요

mooncw added a commit that referenced this pull request Mar 20, 2024
mooncw added a commit that referenced this pull request Mar 20, 2024
@hodadako
Copy link
Member Author

main 머지는 cd를 수정한 PR과 함께 할까요?

네에~! 그렇게 해주세요~

mooncw added a commit that referenced this pull request Apr 5, 2024
mooncw added a commit that referenced this pull request Apr 5, 2024
mooncw added a commit that referenced this pull request Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation 문서화 Feature 기능 개발 Refactor 코드 리팩토링 Setting 개발 환경 세팅 Test test 관련

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[test] Spring Rest Docs 적용

4 participants