# spring-rest-docs

9개의 포스트
post-thumbnail

API 문서화와 Spring Rest Docs

클라이언트가 REST API 애플리케이션에 요청을 전송하기 위해서 알아야 되는요청 정보(요청 URI, request body, query parameter 등)를 정리하여 문서화 하는 것.API 문서 / API 스펙(사양, Specification) : API 사용을

7일 전
·
0개의 댓글
·
post-thumbnail

Spring MVC API 문서화

시작하게 된 계기 및 다짐 😮이번 코드스테이츠의 백엔드 엔지니어링 개발자 부트캠프에 참여하게 되면서 현직개발자 분들의 빠른 성장을 위한 조언 중 자신만의 블로그를 이용하여 배운 것 들을 정리하는게 많은 도움이 된다 하여 시작하게 되었다.그 날 배웠던 것을 길지 않아도

2022년 7월 30일
·
0개의 댓글
·
post-thumbnail

[Spring] Spring Rest Docs Unresolved reference: snippetsDir 해결하기

일단 요약하면, 위 에러는 Spring Rest Docs 를 사용시 spring starter에서 자동으로 생성하는 설정 파일 때문에 발생하는 에러이다.build.gradle.kts를 고치면 해결된다.위 설정을 아래 처럼 바꾸면 해결된다.간단하게 해결!

2022년 7월 5일
·
0개의 댓글
·
post-thumbnail

Spring Rest Docs VS Swagger

모든 기술이 그렇겠지만 이 역시 장전점이 있는 부분이라서나는 스웨거를 추구했지만 팀원들이 Rest Docs를 사용하자고 해서선택하게 되었다. 장단점을 알아보자.우리 프로젝트는 문서화 도구로 Markdown이 아닌 AsciiDoc을 사용했다.ATDD 교육 과정에서 사용

2022년 4월 13일
·
0개의 댓글
·
post-thumbnail

[Spring] Spring rest docs 적용기(gradle 7.0.2)

gradle 7 버전에서 spring rest docs 적용 방법과 겪은 문제

2021년 7월 6일
·
8개의 댓글
·

API 문서 자동화 - Spring REST Docs

API 문서를 자동화 도구로는 대표적으로 Spring REST Docs와 Swagger가 있다. 흔히 두 가지를 두고 무엇을 사용할까 고민하실 것이다. 이번 글에서는 Spring REST Docs를 왜 사용하고, 어떻게 사용하는지 알아볼 것이다. Swagger는 다음

2020년 11월 12일
·
0개의 댓글
·
post-thumbnail

Spring Rest Docs와 Open Api (Swagger)

안녕하세요! 오늘은 Spring 진영의 문서화 프레임워크인 Spring Rest Docs와 Swagger를 비교하는 글을 작성해 볼까 합니다. Peloton 프로젝트 진행 중에 문서화와 관련해서 고민했던 부분들을 정리 해보았어요. 함께 공유해보면 좋을 것 같아요.Spr

2020년 9월 14일
·
2개의 댓글
·