깃허브 RestDoc 문서 올리는 방법

깃허브 RestDoc 문서 올리는 방법

1. 설정 페이지

Branch

• main에서 작업한 경우 main로 설정 후 Save
• dev에서 작업한 경우 dev로 설정 후 Save

설정 시, 해당 branch로 사이트 자동 생성

2. Readme.md

./gradlew clean build

clean 반드시 필요(new 하기 때문에)

만약 RestDocs 생성하면 api-docs.html 파일 총 2개 생성 됨

• src/main/resources/static/docs/api-docs.html(깃허브 상에 올릴 파일)
• src/docs/asciidoc/api-docs.html

3. 완성

https://jasonsong97.github.io/JUnit-bank/src/main/resources/static/docs/api-docs.html