Swagger 제거 및 Spring Rest docs 적용

[devFancy]

• 💯 테스트는 통과했나?
• ✅ 빌드는 성공했나?
• 🧹 불필요한 코드는 제거했나?
• 💭 이슈는 등록했는가?
• 🔖 라벨은 등록했나? ex. feature, refactor

작업 내용

• 기존 Swagger와 관련된 어노테이션 제거, 의존성 제거
• build.gradle에 Spring RestDocs 관련 의존성 추가
• 기존 컨트롤러 테스트 코드에 RestDocs 적용
  • 회원 컨트롤러 테스트 코드에 RestDocs 적용
  • 인증 컨트롤러 테스트 코드에 RestDocs 적용
  • 프로필 컨트롤러 테스트 코드에 RestDocs 적용
  • 게시글 컨트롤러 테스트 코드에 RestDocs 적용
• 기존 코드에서 에러 처리
  • fix: 본인의 프로필을 조회하는 API에 대한 테스트 코드에서 get 방식으로 수정

추가

• build.gradle 에서 RestDocs에 대한 의존성 수정 및 순서에 대한 설명 추가 - 커밋(3a8433a)

주의사항

• Closes 기존 API 문서로 사용했던 Swagger 에서 Spring Rest Docs로 전환한다. #7

실행 및 결과

실행

• 방법1. 오른쪽 Gradle - Tasks - documentation - asciidoctor 실행
• 방법2. 터미널 창에 ./gradlew asciidoctor 입력
• 방법3. build.gradle 파일에서 asciidoctor 왼쪽에 Run 버튼 클릭

결과

• build > docs > asciidoc > index.html 파일 -> Chome 창을 열면 아래와 같이 API 문서가 나온다.

[github-actions]

Test Results

486 tests  ±0   486 ✅ ±0   3s ⏱️ ±0s
 29 suites ±0     0 💤 ±0 
 29 files   ±0     0 ❌ ±0 

Results for commit c46b4ac. ± Comparison against base commit e84424f.

This pull request removes 10 and adds 10 tests. Note that renamed tests count towards both.

com.hibitbackendrefactor.post.application.PostServiceTest ‑ [2] logs=10:2/3, expectedIncreasedViewCount=1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [1] log=, postId=1, expectedUpdatedLog=10:1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [2] log=9:1/2/3, postId=1, expectedUpdatedLog=10:1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [2] logs=10:1/2/3, postId=4, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [3] log=10:1/2/3, postId=4, expectedUpdatedLog=10:1/2/3/4
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [3] logs=10:1/2/3, postId=3, expected=false
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [4] log=9:1/2/3&10:1/2, postId=3, expectedUpdatedLog=10:1/2/3
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [4] logs=9:1/2/3, postId=3, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [5] logs=9:1/2/3&10:1/2, postId=3, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [6] logs=9:1/2/3&10:1/2/3, postId=3, expected=false

com.hibitbackendrefactor.post.application.PostServiceTest ‑ [2] logs=21:2/3, expectedIncreasedViewCount=1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [1] log=, postId=1, expectedUpdatedLog=21:1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [2] log=20:1/2/3, postId=1, expectedUpdatedLog=21:1
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [2] logs=21:1/2/3, postId=4, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [3] log=21:1/2/3, postId=4, expectedUpdatedLog=21:1/2/3/4
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [3] logs=21:1/2/3, postId=3, expected=false
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [4] log=20:1/2/3&21:1/2, postId=3, expectedUpdatedLog=21:1/2/3
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [4] logs=20:1/2/3, postId=3, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [5] logs=20:1/2/3&21:1/2, postId=3, expected=true
com.hibitbackendrefactor.post.domain.ViewCountManagerTest ‑ [6] logs=20:1/2/3&21:1/2/3, postId=3, expected=false