#15. Spring RestDocs - GitPage Hosting

JUnit 통과를 통해 생성된 문서 snippets을 사용하여 index.adoc 파일을 작성한 이후,
프로젝트 Build 를 통해 생성된 index.html을 외부에서도 확인할 수 있도록
GitPage를 통해 호스팅 하는 법을 정리하고자 한다.

[ GitPage Hosting 하는 법 ]

#1. Repository와 연동된 디렉토리의 root 경로로 이동하여 docs 폴더를 생성한다.

#2. 기존 설정대로라면 index.adoc 작성 완료 이후 프로젝트의 build를 성공적으로 마치게되면main/resources/static/docs 경로에 index.html 파일이 생성되어 있다.
이 index.html 파일을 루트 경로에 생성한 docs 폴더로 이동시킨다.

#3. GitHub 사이트 이동하여 프로젝트와 연동된 Repository 클릭.

#4. 우측 상단에 Settings 버튼 클릭

#5. 좌측 중앙에 Pages 버튼 클릭

#6. Build and deployment 카테고리에 호스팅 파일의 기준 브랜치 및 폴더 설정 후 save 버튼.

정상적으로 저장이 되고 나면 화면 상단에 위치한 Link를 확인할 수 있다.

위의 링크를 들어가면 아래와 같이 Spring RestDocs 의 API 명세서를 외부에서도 접속할 수 있다.

[주의] - 최초 생성 이후 index.adoc 코드나 test 코드가 수정될 경우.

#1. 기존에 생성된 snippet을 삭제
#2. 변경된 JUnit test 성공 이후 새로 생성된 snippets 으로 index.adoc 작성
#3. 새로 build 후 생성된 html 파일을 루트 경로의 docs 폴더로 이동.
#3. GitPages에 설정한 브랜치에 commit/push.
#4. 캐시 기록 삭제 이후 다시 URL로 들어가면 적용되어 있다.