/spring-swagger2markup-demo

A demo project template using Swagger2Markup, Spring Boot, Springfox and spring-restdocs

Primary LanguageJava

Swagger2Markup Demo

Build Status Apache License 2 Twitter Join%20Chat

Overview

This project is a Swagger2Markup (AsciiDoc and GitHub Flavored Markdown) converter demo using Spring Boot, springfox and spring-restdocs.
The demo shows how to generate static docs (HTML5 and PDF) with the swagger2markup-gradle-plugin and serve them in a Spring Boot app under http://localhost:9080/docs/index.html and http://localhost:9080/docs/index.pdf.

See Swagger2Markup and swagger2markup-gradle-plugin for more details and usage guide.

Usage guide

Gradle

If you want to start the Spring Boot application, please run:

gradlew clean build
java -jar build/libs/spring-swagger2markup-demo-1.1.0.jar

If you only want to generate the HTML and PDF documentation, please run:

gradlew clean asciidoctor

The results are generated into build/asciidoc/html5 and build/asciidoc/pdf.

Maven

If you want to start the Spring Boot application, please run:

mvn clean package
java -jar target/spring-swagger2markup-demo-1.1.0.jar

If you only want to generate the HTML and PDF documentation, please run:

mvn clean test

The results are generated into target/asciidoc/html and target/asciidoc/pdf.

Demo

Screenshot

Demo