restdocs custom

RestDocs - Custom Error Code Enum 문서화

RestDocs - Custom Error Code Enum 문서화 Enum으로 Custom ErrorCode 관리시 Enum 문서 자동화 방법 SpringBoot 버전 2.7.8 restdocs 버전 2.0.7 개요 데브코스에서 프로젝트를 하다 고민이 생겼습니다. 프론트엔드와의 협업간에 API 문서로 Spring RestDocs를 사용하고 있었고, API 사용 시 에러 응답에 대해 httpStatus 코드만으로는 클라이언트에 에러에 대해 디테일하게 설명할 수가 없어서 클라이언트가 개발과정 중 생긴 오류들에 대해 정확하게 알 수 있게 우리는 ErrorCode를 Enum으로 정의해서 내려주기로 하였습니다. public enum ErrorCode { ... NOT_MATCHED_COMMENT_AUTHOR(H..

RestDocs에서 Snippet 파일명 커스텀, Restdocs Link(링크) 걸기

RestDocs에서 파일명은 일반적으로 request(response)-fields, request(response)-body 등의 규칙이 있다. Snippet 파일은 보통 src/test/resources/org/springframework/restdocs/templates/asciidoctor 아래에 커스텀하여 두는데, 이 때도 파일명을 규칙에 맞게 사용해야 requestFields() 메서드, responseFeilds() 메서드 등이 이해하여 커스텀 snippet을 읽어서 문서를 만들어준다. 이 때 규칙을 찾아보면, AbstractFieldsSninnpet이나 AbstractBodySnippet 이나, 생성자에서 첫번째 파라미터로 String type 또는 String name이라는 파라미터를 받..

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..