본문 바로가기

신비한 개발사전

검색하기
신비한 개발사전
프로필사진 jbilee

  • 분류 전체보기 (100)
    • JavaScript (5)
    • Algorithms (3)
    • CS (25)
    • Frontend (27)
    • Backend (23)
    • Java (1)
    • Maths & Physics (1)
    • Devlog (0)
Guestbook
«   2025/06   »
일 월 화 수 목 금 토
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30
Recent Posts
Tags
  • AWS
  • v-calendar
  • module
  • websocket
  • vue
  • Webpack
  • axios
  • CSS
  • konva
  • javascript
  • React
  • jscode
  • github
  • clerk
  • pwa
  • Canvas
  • NextJS
  • spring
  • nuxt
  • Firebase
more
Archives
관리 메뉴
  • 글쓰기
  • 방명록
  • RSS
  • 관리

목록2025/06/07 (1)

신비한 개발사전

Spring REST Docs 적용기

Spring REST Docs는 API 문서를 작성할 때 필요한 각종 코드 스니펫을 자동으로 생성해주는 도구다. 생성된 스니펫을 조합해 자유도 높은 형식으로 API 문서를 만들어낼 수 있다. 순수한 문서이기 때문에 Swagger처럼 API 호출을 시뮬레이팅할 순 없지만, 테스트 코드를 기반으로 문서화를 지원하기 때문에 겸사겸사 테스트 코드를 작성하는 기회를 마련해주기도 한다. Spring REST Docs는 AsciiDoc과 Mustache 문법을 사용한다. 초기 세팅build.gradle에 REST Docs 관련 설정을 먼저 추가해준다. REST Docs가 생성해주는 스니펫을 어디에 저장할지, 그리고 빌드할 때 어디에 있는 asciidoc으로 최종 HTML 문서를 만들지 등을 설정한다.plugins {..

Backend 2025. 6. 7. 16:17
이전 Prev 1 Next 다음

Blog is powered by kakao / Designed by Tistory

티스토리툴바

단축키

내 블로그

내 블로그 - 관리자 홈 전환
Q
Q
새 글 쓰기
W
W

블로그 게시글

글 수정 (권한 있는 경우)
E
E
댓글 영역으로 이동
C
C

모든 영역

이 페이지의 URL 복사
S
S
맨 위로 이동
T
T
티스토리 홈 이동
H
H
단축키 안내
Shift + /
⇧ + /

* 단축키는 한글/영문 대소문자로 이용 가능하며, 티스토리 기본 도메인에서만 동작합니다.