Spring Rest Docs 사용 가이드

목차(Table of Contents)

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

프로젝트 소개

'Spring REST Docs 가이드'를 위한 예제프로젝트 입니다.

'Spring Boot'를 기반으로 하고 있으며 간단하게 "Spring REST Docs" 와 "Swagger-UI" 를 활용한 API문서를 제공합니다.

(최상단 이동)

시작하기

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

요구사항

• Java 17 이상
  • Java 설치방법: 여러 개의 JDK를 설치하고 선택해서 사용하기

설치

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

5. 애플리케이션 실행

./gradlew apiBuild
cd build/libs
java -jar application.jar

확인

Spring REST Docs

http://localhost:8080/docs/index.html

Spring REST Docs - OpenAPI Specification Integration

http://localhost:8080/swagger/swagger-ui.html

Springdoc

http://localhost:8080/swagger-ui/index.html

(최상단 이동)

부록

• 여러 개의 JDK를 설치하고 선택해서 사용하기
• Spring REST Docs
  • Github - Spring REST Docs
  • Spring REST Docs - Reference Documentation
• Asciidoctor
  • Gradle - org.asciidoctor.jvm.convert`
• Springdoc - Openapi
  • Swagger annotation