Adrian's Dev Journal

  • 홈
  • 태그
  • 방명록

Spring REST Docs 1

Spring Rest Docs Tutorial

backend 개발자들이 API 문서화를 하는 방법에는 여러 가지 방법이 있다. 1. 수기를 통한 문서화 2. postman publish 기능을 통한 문서화 3. swagger를 활용한 문서화 4. Spring REST Docs를 활용한 문서화 ... 각각의 API 문서화마다 장단점이 있을 것이다. 특히 1번, 2번 방식은 별로 추천하지 않는 방식이다. [추천하지 않는 이유] api 명세가 바뀌었을 때 까먹고 바꿔주지 않는다면 api 명세 기능을 잃어버린다. 개발자가 실수로 오타를 내었을 때 누군가 알려주지 않는 이상 이를 발견하기 힘들다. Swagger와 Rest Docs 방식을 통한 API 문서화 방법 중 이번 장에서는 Spring Rest Docs를 활용한 API 문서화 방법을 알아보려고 한다. ..

Spring 2023.04.06
이전
1
다음
더보기
프로필사진

백엔드 개발자가 배우고 기록하는 기술 블로그입니다.

  • 분류 전체보기 (61)
    • Spring (17)
    • 개발일지 (5)
    • Refactoring & CleanCode (3)
    • AWS (1)
    • Java (20)
    • CS 지식 (5)
    • 데브코스 (1)
    • DesignPatterns (2)
    • 회고 (6)
    • Gradle (1)

Tag

Collection Framework, 인프콘2023, API문서화, jdbctemplate, 데브코스, 디자인패턴, 회고, Spring, Java, asciidoc, Spring REST Docs, Test code, submodule, 객체지향 원칙, restdocs, MethodReference, refactoring, AuthenticationSuccessHandler, 인프콘, 리팩터링,

최근글과 인기글

  • 최근글
  • 인기글

최근댓글

공지사항

페이스북 트위터 플러그인

  • Facebook
  • Twitter

Archives

Calendar

«   2025/05   »
일 월 화 수 목 금 토
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 31

방문자수Total

  • Today :
  • Yesterday :
GitHub

Copyright © Kakao Corp. All rights reserved.

티스토리툴바