brainagenet / spring-restdocs-seminar

Spring REST Docs Example

Modern Java web application with Spring

Overview

Modern Java web application with Spring 세미나를 통해 공유한

Making your API easy to document with Spring REST Docs 섹션 샘플링 프로젝트 입니다.

Example RESTful API Documents

Example RESTful API Data Schema

Learning more

Slides 자료

Building from source

requires Java8

• gradle spring boot WAS Start

gradlew copyAsciidocResources bootRun

API : http://127.0.0.1:8080

Doc : http://127.0.0.1:8080/docs

• IDEA, STS, Eclipse WAS Start

requires Lombok

gradlew copyAsciidocResources task 실행하면 *.adoc → *.html 만들어 진 후 src/main/resource/static/docs 폴더 밑에 copy 되어 집니다.

gradlew copyAsciidocResources

src/main/resource/static/docs/*.html 만들어 졌으면 MainClass로 서버를 시작 합니다.

MainClass : io.example.SampleBootRunner.class