이 글의 내용은 Spring Rest Docs를 이미 사용하고 있는 상황에서 OpenAPI 문서를 만들기 위한 내용을 담고 있습니다. OpenAPI Specification 소개 OpenAPI Specification은 예전엔 Swagger Specification으로 알려졌었다. OpenAPI Specification은 Rest API에 대해 문서화를 하기 위한 사양을 정의한 것으로 특정한 소프트웨어나 라이브러리가 아니다. SmartBear Software 회사가 자사 swagger framework에서 REST Api를 문서화하기 위해 사용하던 Swagger Specification을 공개하면서 Linux Foundation의 OpenAPI Initiative project로 관리가 이전되었다. ht..

Spring Rest Doc 문서를 만드는데 generated-snippets에 생성된 response-body.adoc 가 eclipse에서 test 코드를 실행했을 땐 정상적으로 결과가 나오는데 mvn 명령으로 실행했을 땐 한글이 깨져서 생성되었다. 처음엔 maven-compiler-plugin의 encoding 문제인가 의심했지만 해당 문제가 아니었다. 한글 깨짐을 해결할 수 있는 방법이 2가지가 있는데 하나는 요청 accept header에 charset=UTF-8을 추가하는 것이다. this.mockMvc.perform( post("/someUrl") .accept(MediaType.APPLICATION_JSON_UTF8) .params(params) .cookie(getLoginCookie()..

eclipse의 AsciiDoctor Editor를 사용하면서 설정한 내용임 asciidoc 문서 작성을 위해 프로젝트를 설정하면서 예제 소스를 include 하기 위해 다음과 같이 설정하였다. org.asciidoctor asciidoctor-maven-plugin ${asciidoctor.maven.plugin.version} org.springframework.restdocs spring-restdocs-asciidoctor ${spring-restdocs.version} asciidoc-to-html prepare-package process-asciidoc html5 coderay true src/main/resources/static ${java.version} ${spring-restdocs..

Spring Rest Docs 2.0.5.RELEASE 기준으로 작성된 글 maven 빌드 기준 설명임 Spring REST Docs 소개 Sprig Rest Docs 문서 Spring REST Docs Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test. docs.spring.io Spring Rest Docs는 asciidoc 개발 문서 작성에 spring web 요청/응답 결과에 대한 문서 자동화를 지원해주는 라이브러리이다. 예전에 spring boot + swagger기반의 라이브러리인 springfox swagger를 사용해서..