Spring/RestDocs

IntelliJ Restdocs Unexpected token - .snippet 파일을 AsciiDoc로 인식하지 않을 때

Restdocs 커스텀을 위하여 src/test/resources/org/springframework/restdocs/templates 경로에 snippet 파일을 추가하여 작성하면 다음처럼 인식이 되지 않아서 작성하기 힘든 경우가 생긴다. Unexpected token 빨간줄에, 문법 형식도 맞지 않게 작성된다. Intellij 설정을 바꾸면 해결된다. 해결법 Mac 기준 Preferences -> Editor -> File Types -> Recognized File Types Recognized File Types 에서 마우스 조금 내리다보면 AsciiDoc files보인다. File name patterns에 *.snippet 추가 writing AsciiDoc works best with sof..

RestDocs By Gradle 설정

환경 Spring Boot 2.7.6 Gradle 7.2 Java 11 junit5 MocvMvc build.gradle 먼저 전체 설정이다. plugins { id 'java' id 'org.springframework.boot' version '2.7.6' id 'io.spring.dependency-management' version '1.0.15.RELEASE' id "org.asciidoctor.jvm.convert" version "3.3.2" } configurations { compileOnly { extendsFrom annotationProcessor } asciidoctorExt } repositories { mavenCentral() } ext { set('snippetsDir', ..

RestDocs, Swagger 조합해서 사용하기 (RestDocs + Swagger)

RestDocs와 Swagger를 같이 사용하는 방법 Swagger Vs Spring Rest Docs 스웨거(swagger)나 rest docs 둘다 코드를 통해 API 문서를 만들어주는것은 동일하다. 그러나 다음과 같은 차이점과 장단점이 있다. Spring Rest Docs Swagger 장점 - 프로덕션 코드에 영향이 없다. - 테스트 코드가 성공해야(Controller Layer) 문서 작성이 가능하다. - 문서상에 API를 테스트할 수 있는 기능이있다. - 테스트 코드가 필요없으므로 적용이 쉽다. (어노테이션을 적용 안해도 Controller를 읽고 자동으로 적용. 어노테이션을 추가하면 추가 설명을 적을 수 있다.) 단점 - 테스트 코드를 작성해야 하므로 적용이 불편하다. - 문서를 위한 테스트..

Spring Rest Docs - Spring Boot V2...

Spring Rest docs - in springboot v2 API를 개발하고 이에 대한 스펙이나 문서를 다른이에게 공유하기에 앞서서 우리는 API문서라는 것을 만들어야한다. API 문서를 만들어야 팀원들끼리 공유, 또는 타 엔지니어들과 공유할 수 있다. API문서를 만드는 법은 크게 다음과 같이 나뉜다 직접 markdown 또는 wiki 작성 postman 이용 swagger 사용 spring rest docs 사용 그 중, swagger와 rest docs는 직접적으로 코드 실행시 자동으로 문서를 만들어 준다. 먼저 이 둘을 비교하고, restdocs에 대해 정리해보고자 한다. 이 글은 springboot 버전 2점대에서 사용하는 방법을 정리한 글이다 3점대부터는 공식홈페이지에 정확한 설정 방법이..