Spring Rest Docs 사용 가이드

목차(Table of Contents)

1. 프로젝트 소개
2. 시작하기
   • 준비사항
   • 설치
3. 협업방법
4. 부록

프로젝트 소개

곧 기술블로그를 통해 'Spring REST Docs 작성가이드 공유드리겠습니다.'

(최상단 이동)

시작하기

프로젝트를 로컬에서 시작하려면 다음 안내를 따라주시면 됩니다.

요구사항

설치

1. 리포지토리 복제(Clone the repo)

   git clone [email protected]:thefarmersfront/spring-rest-docs-guide.git
   cd spring-rest-docs-guide

2. 프로젝트 구성하기(Build project)

   ./gradlew clean build

3. API문서생성

   ./gradlew clean restDocsTest

4. 생성문서 확인

   1. Spring REST Docs: build/docs/index.html
   2. SwaggerUI: api-spec/openapi3.yaml

(최상단 이동)

협업방법

• 프로젝트를 새롭게 시작했거나 프로젝트 문서가 없다면 확인자가 문서를 생성합니다.
• PUSH 전에 checkStyle, sonarlint 등을 이용해 코드를 정리해주세요.
• Pull Request 전에는 로컬 테스트를 반드시 수행해 주세요.

(최상단 이동)

부록

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• sdkman.io
• Markdown Guide
• Best-README-Template