Code Monkey home page Code Monkey logo

spring-swagger2markup-demo's Introduction

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 .

See Swagger2Markup and spring-swagger2markup-demo for more details and usage guide.

Usage guide

Maven

如果想生成HTML或者PDF文档,请先修改io.github.robwin.swagger2markup.petstore.Swagger2MarkupTest里的 注意这个接口必须要返回swagger的json数据,一定自己先验证下

private static final String SWAGGER_URL = "http://localhost:8085/v2/api-docs";

然后运行:

mvn clean test

最后可以在 target/asciidoc/html and `target/asciidoc/pdf`找到HTML和PDF文档

Screenshot

demo

spring-swagger2markup-demo's People

Contributors

akurdyukov avatar pavgup avatar robwin avatar spiritn avatar

Watchers

 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.