Skip to content
A demo project template using Swagger2Markup, Spring Boot, Springfox and spring-restdocs
Java
Branch: master
Clone or download
Latest commit bdbb518 Aug 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper Fixed issue #1: compiler warning: [options] bootstrap class path not … May 20, 2015
images Updated README Feb 16, 2016
src Updated to Spring Boot 1.4.0.RELEASE Sep 14, 2016
.gitignore maven example added May 20, 2016
.travis.yml Updated swagger2markup-gradle-plugin from 0.9.2 to 1.0.0-SNAPSHOT Apr 4, 2016
README.adoc Updated README Oct 18, 2016
build.gradle Updated Swagger2Markup to 1.3.3 Apr 27, 2018
gradlew gradlew is +x and the version is corrected to 0.7.0 Aug 26, 2015
gradlew.bat
pom.xml upgrade libs Aug 14, 2018
settings.gradle Initial commit Feb 16, 2015

README.adoc

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.

Screenshot

Demo

You can’t perform that action at this time.