Skip to content

A demo project template using Swagger2Markup, Spring Boot, Springfox and spring-restdocs

Notifications You must be signed in to change notification settings

spiritn/spring-swagger2markup-demo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

97 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A demo project template using Swagger2Markup, Spring Boot, Springfox and spring-restdocs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%