spring-swagger2markup-demo

spring-swagger2markup-demo copied to clipboard

= Swagger2Markup Demo :author: Robert Winkler :version: 1.1.0 :hardbreaks:

image:https://travis-ci.org/Swagger2Markup/spring-swagger2markup-demo.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/spring-swagger2markup-demo"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]

== Overview

This project is a https://github.com/RobWin/swagger2markup[Swagger2Markup] (AsciiDoc and GitHub Flavored Markdown) converter demo using https://github.com/spring-projects/spring-boot[Spring Boot], https://github.com/springfox/springfox[springfox] and https://github.com/spring-projects/spring-restdocs[spring-restdocs]. The demo shows how to generate static docs (HTML5 and PDF) with the https://github.com/RobWin/swagger2markup-gradle-plugin[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 https://github.com/RobWin/swagger2markup[Swagger2Markup] and https://github.com/RobWin/swagger2markup-gradle-plugin[swagger2markup-gradle-plugin] for more details and usage guide.

== Usage guide

=== Gradle

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

[source,groovy]

gradlew clean build

[subs="attributes"]

java -jar build/libs/spring-swagger2markup-demo-{version}.jar

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

[source,groovy]

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:

[source,groovy]

mvn clean package

[subs="attributes"]

java -jar target/spring-swagger2markup-demo-{version}.jar

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

[source,groovy]

mvn clean test

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

== Demo

[subs="attributes"] See live demo on GitHub Pages: http://swagger2markup.github.io/spring-swagger2markup-demo/{version}

== Screenshot

image:images/Demo.PNG[]