Spring RestDocs 이용해서 api 문서 만들기


Spring RestDocs 이용해서 api 문서 만들기

RestDocs 는 Controller 테스트 하면서 같이 코드를 작성해 api 문서를 쉽게 작성하게 해주는 도구다 의존성 추가 및 설정 빌드하면 build 에 asciidoc/html5 폴더에 html 문서가 생기는데 이걸 resources/static/docs 로 복사해서 자동화를 해주었다. 테스트코드 + RestDocs 회원이 어떤 상대를 팔로잉 하는 테스코드이다. pathParameters 값을 restDocs 에 이용하려면 RestDocumentRequestBuilders 의 post, get 메서드를 이용해서 테스트 해야한다. 1. pathParameter 값에 대한 문서 작성 코드 2. request 필드들에 관한 문서 작성 코드 3. response 필드들에 관한 문서 작성 코드 이렇게 작성하면(위 예제에선 Authorization 헤더는 작성 하..........



원문링크 : Spring RestDocs 이용해서 api 문서 만들기