Project/협업프로젝트

[협업프로젝트] SwaggerUI + Spring RestDocs 로 API 문서화하기

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

[협업 프로젝트] Git Flow, 커밋 컨벤션, Issues 프로젝트 적용하기

서론 Spring Boot를 이용한 RESTful Web Service를 개발 및 학습하는 과정 중 BE와 FE 협업 프로젝트를 함께 진행하는 것이 실제 개발 환경에서의 경험 (BE, FE 실제 현업과 유사한 개발환경) 커뮤니케이션 강화 효율적인 개발 FE, BE 지식 공유 종합적인 시스템 이해 측면에서 장점을 가지고 있을 것이라고 생각하고 커뮤니티에서 BE, FE 협업 프로젝트를 확인하고 진행하게 되었다. 프로젝트의 형상관리 툴은 git으로 결정하였고, git으로 결정한 이유는 다음과 같다. 팀원 전체의 사용 경험 분산 집중형 버전관리 및 개발 (Git - flow 전략) 커밋 컨벤션을 활용한 코드 메시지 구조 구체화 Issue와 프로젝트를 통한 MVP 스프린트 통합 관리 여기서 우리는 형상관리를 더 ..