Swagger2Markup Demo
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 buildjava -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 asciidoctorThe 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 packagejava -jar target/spring-swagger2markup-demo-1.1.0.jar
If you only want to generate the HTML and PDF documentation, please run:
mvn clean testThe results are generated into target/asciidoc/html and target/asciidoc/pdf.
Demo
See live demo on GitHub Pages: http://swagger2markup.github.io/spring-swagger2markup-demo/1.1.0
Screenshot
