Giter VIP home page Giter VIP logo

spring-swagger2markup-demo's Introduction

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

spring-swagger2markup-demo's People

Contributors

robwin avatar pavgup avatar

Watchers

Armel Soro avatar James Cloos avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.