# Springboot-Swagger2-Demo

**Repository Path**: jonykchen/Springboot-Swagger2-Demo

## Basic Information

- **Project Name**: Springboot-Swagger2-Demo
- **Description**: SpringBoot+Swagger2集成项目，可以看到swagger-ui，针对swagger自带界面比较丑的问题，集成了萧明大神的SwaggerBootstrapUI，目前项目支持导出离线PDF，Html，MarkDown接口文档，仅供个人学习。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2019-09-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Springboot-Swagger2-Demo

#### 介绍
SpringBoot+Swagger2集成项目，可以看到swagger-ui，针对swagger自带界面比较丑的问题，集成了萧明大神的SwaggerBootstrapUI，目前项目支持导出离线PDF，Html，MarkDown接口文档，仅供个人学习。

#### 软件架构
软件架构说明


#### 使用说明

##### 1. 启动项目就可以在日志中看到详细的在线文档访问路径地址

  Application Springboot-Swagger2-Demo is running! Access URLs

 	Local: 		http://localhost:8082
 	
 	External: 	http://192.168.1111.1111:8082
 	
 	Doc: 		http://192.168.1111.1111:8082/doc.html
 	
 	Swagger-ui:	http://192.168.1111.1111:8082/swagger-ui.html`
 	
##### 2. 如需导出离线文档，只需要进行以下操作
第一种方式:在idea中直接配置maven命令

第二种方式:运行时只需要在项目上右击-->`Run As`-->`Maven clean`-->在项目上右击-->`Run As`-->`Maven test`，只要控制台显示成功，在当前项目的`target\asciidoc\html`和`target\asciidoc\pdf`分别存放着`HTML文档`和`PDF文档`。

#### 离线文档实现原理：

1. 先利用`SpringFox`库生成`RESTful API`
2. 再利用`Swagger2Markup` Maven插件生成`asciidoc`文档
3. 最后利用`asciidoctor` Maven插件生成 html 或 pdf 文件

##### 3. 页面截图
![SwaggerBootstrapUI](https://images.gitee.com/uploads/images/2019/0908/200502_b7513e69_1385389.png "2.png")
![Swagger-ui](https://images.gitee.com/uploads/images/2019/0908/200448_974d687d_1385389.png "1.png")


#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request