[우아한테크코스] 6월 14일 TIL

[Spring] Rest docs 사용

방안 1

1. 컨트롤러 테스트 클래스 상단에 @AutoConfigureRestDocs 추가
2. mockMvc 하단에 아래 두 줄 추가

    .andDo(print())
    .andDo(document("member/login"));
   

   print()는 snippet으로 나타날 결과를 보기 위함이므로 선택사항

3. 테스트 실행시켜 generated-snippets/member/login 에 http-request.adoc, http-response.adoc 생성 확인
4. src/docs/asciidoc 하위에 ~~.adoc 문서 작성

   == Member(멤버) 
   === 멤버 로그인 / 회원가입
   ==== Request
   include::{snippets}/member/login/http-request.adoc[]
   ==== Response
   include::{snippets}/member/login/http-response.adoc[]
   

5. src/docs/asciidoc/index.adoc에 새로 만든 ~~.adoc 없으면 추가

   ...
   include::member.adoc[]
   include::내가추가한파일.adoc[]
   ...
   

6. build.gradle에서 asciidoctor 화살표 실행시켜 build.asciidoc/html5/index.html 생성 확인
7. 문서 실제 띄워보기

   ./gradlew clean bootJar
   java -jar build/libs/*.jar