[Spring] Spring REST Docs 알아보기!


[Spring] Spring REST Docs 알아보기!

이번에 이직한 현재 회사의 경우에는 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를 기반으로...


#테스트 #SpringBoot #Swagger #강제 #검증 #문서화 #스프링 #스프링부트 #코드 #Spring #RESTAPI #REST #Boot #build #Docs #Entity #Dto #Test #Controller #gradle #의존성 #주입 #Repository #asciidoc

원문링크 : [Spring] Spring REST Docs 알아보기!