Spring REST Docs 참고 자료들

간단 요약 / 비고

작성일

May 17, 2022

작성자

기술 태그

SpringRESTDocs

Spring REST Docs 레퍼런스 들입니다. 매우매우! 유용할 것 같습니다! 😎

Spring REST Docs

The aim of Spring REST Docs is to help you produce accurate and readable documentation for your RESTful services. Writing high-quality documentation is difficult. One way to ease that difficulty is to use tools that are well-suited to the job. To this end, Spring REST Docs uses Asciidoctor by default.

Spring REST Docs

https://docs.spring.io/spring-restdocs/docs/current/reference/html5/

spring-restdocs/ApiDocumentation.java at v2.0.6.RELEASE · spring-projects/spring-restdocs

This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters You can't perform that action at this time. You signed in with another tab or window.

spring-restdocs/ApiDocumentation.java at v2.0.6.RELEASE · spring-projects/spring-restdocs

https://github.com/spring-projects/spring-restdocs/blob/v2.0.6.RELEASE/samples/rest-notes-spring-data-rest/src/test/java/com/example/notes/ApiDocumentation.java

spring-restdocs/ApiDocumentation.java at v2.0.6.RELEASE · spring-projects/spring-restdocs

Spring Rest Docs 적용 | 우아한형제들 기술블로그

안녕하세요? 우아한형제들에서 정산시스템을 개발하고 있는 이호진입니다. 지금부터 정산시스템 API 문서를 wiki 에서 Spring Rest Docs 로 전환한 이야기를 해보려고 합니다. 현재 정산시스템은 API 문서를 wiki 로 공유하고 있었습니다. 며칠 전 API 에 필드를 추가하고 API 문서를 확인해보니 변경된 코드와 달랐습니다. 있어야 할 필드가 없었고 없어야 할 필드가 있었으며 같은 값을 주는 필드가 각기 다른이름의 필드로 제공되었습니다.

Spring Rest Docs 적용 | 우아한형제들 기술블로그

https://techblog.woowahan.com/2597/

Spring Rest Docs 적용 | 우아한형제들 기술블로그

Spring REST Docs에 날개를... (feat: Popup) | 우아한형제들 기술블로그

안녕하세요? 우아한형제들에서 정산시스템을 개발하고 있는 이호진입니다. 2018년 12월 Spring REST Docs를 주제로 사내 블로그를 작성 후... 1년 이상이 지났습니다. Spring REST Docs를 적용 후 빠르게 타 시스템에 API 스펙을 제공할 수 있다는 장점을 누렸던 반면 API 가 늘어날수록 단점이 부각 되었고 이 단점을 해소하기 위해 방법( 꼼수)을 연구 했습니다.

Spring REST Docs에 날개를... (feat: Popup) | 우아한형제들 기술블로그

https://techblog.woowahan.com/2678/

Spring REST Docs에 날개를... (feat: Popup) | 우아한형제들 기술블로그

Spring REST Docs 적용 및 최적화 하기

해당 포스팅의 코드는 Github 를 참고해주세요. 테스트 코드 기반으로 Restful API 문서를 돕는 도구입니다. Asciidoctor를 이용해서 HTML 등등 다양한 포맷으로 문서를 자동으로 출력할 수 있습니다. RestDocs의 가장 큰 장점은 테스트 코드 기반으로 문서를 작성한다는 점입니다. API Spec과 문서화를 위한 테스트 코드가 일치하지 않으면 테스트 빌드를 실패하게 되어 테스트 코드로 검증된 문서를 보장할 수 있습니다.

Spring REST Docs 적용 및 최적화 하기

https://backtony.github.io/spring/2021-10-15-spring-test-3/

Spring REST Docs 적용 및 최적화 하기