
[협업프로젝트] SwaggerUI + Spring RestDocs 로 API 문서화하기
·
Project/협업프로젝트
SwaggerUI VS Spring REST Docs 팀 프로젝트 스택 결정 시 API 문서화를 도와주는 프레임워크에 Spring Rest Docs와 Swagger가 언급되었고, 두 가지 스택 중 한 스택을 결정하기로 하였다. 다음은 어떤 스택을 사용할지에 대해 서로 공부해서 소통하기로 한 결과를 표로 정리한 내용이다. 주요 특징 Spring Rest Docs Swagger 주 용 도 테스트 기반 API 문서화 API 스펙 정의 및 시각적 문서화 문서화 방식 테스트 케이스를 사용하여 API를 호출하고 문서화 API 스펙을 정의하고 자동으로 시각적 문서를 생성 테스트 기반 문서화 예 (JUnit, REST Assured, MockMvc 등을 사용) 아니요 문서 형식 다양한 형식을 지원 (HTML, Asci..