이번에 이직한 현재 회사의 경우에는 REST API를 문서화 하는 방법 중 하나인 Spring REST Docs를 사용하고 있어서 이번에 사용 방법에 대해서 한번 정리해봤다. 우선, Spring REST Docs란 무엇일까??
- Spring REST Docs는 REST API를 문서화 하기 위해 제공하는 기능으로 REST API를 명세화 하는 방법은 여러가지 방법이 있지만 Swagger와 REST Docs의 차이점만 비교하고 REST Docs에 대해서 알아보자. 1. Swagger - Controller를 기준으로 기본적인 REST API 문서를 작성해준다. - 제공되는 Annotation으로 문서를 보완할 수 있다. - Production Code에 Annotation으로 기술하기 때문에 코드의 가독성이 떨어진다 - Spring Security를 적용하여 권한에 따라 노출할때 설정을 하기 까다롭다. 2.
REST DOCS - Controller에 대한 Test Code를 기반으로...
![[Spring] Spring REST Docs 알아보기!](https://mblogthumb-phinf.pstatic.net/MjAyMjA0MDRfMTcz/MDAxNjQ5MDYyNTAwNTc3.hi4cuqSmqN3H1d2tzloXT7DOsa-9Ua9571I8cYFBNSUg.IYux2SVUgEohAXup_Lh63fbMmwyzAJQibItYKZ6Swcog.PNG.mygoaway/%BD%BA%C5%A9%B8%B0%BC%A6_2022-04-04_%BF%C0%C8%C4_5.54.52.png?type=w2)
#
테스트
#
SpringBoot
#
Swagger
#
강제
#
검증
#
문서화
#
스프링
#
스프링부트
#
코드
#
Spring
#
RESTAPI
#
REST
#
Boot
#
build
#
Docs
#
Entity
#
Dto
#
Test
#
Controller
#
gradle
#
의존성
#
주입
#
Repository
#
asciidoc
원문 링크 : [Spring] Spring REST Docs 알아보기!
![[제대로 파는 Git & Github - by 알코] 2. 시간 여행하기](https://mblogthumb-phinf.pstatic.net/MjAyMjAzMTNfMjEw/MDAxNjQ3MTU0NzY1NTA0.APxoj5Jv5nNRPrQp1XseTmGV-yPYT8pGK1brf_nGOdMg.4kyMqzIrytNLn1T1TWd8VrNVNWN15jfjesesASr-eHkg.PNG.mygoaway/%BD%BA%C5%A9%B8%B0%BC%A6_2022-03-13_%BF%C0%C8%C4_3.58.58.png?type=w2)
![[macOs] 맥 사용하는 포트 조회 및 포트 죽이기](https://mblogthumb-phinf.pstatic.net/MjAyMjA0MDRfMjQw/MDAxNjQ5MDU0MjI4Njgw.qMcWqPk4EXWaNitDFYdaMKrDX0xnRN3gVVuprX06QJYg.87IvW7TIYIhq4SylQ0B4vnSbZAwhFyNvKPk66AX2MvMg.PNG.mygoaway/%BD%BA%C5%A9%B8%B0%BC%A6_2022-04-04_%BF%C0%C8%C4_3.34.30.png?type=w2)
![[Java] Jackson 라이브러리 이해하기](https://blogimgs.pstatic.net/nblog/mylog/post/og_default_image_160610.png)