# swagger-offline-doc

**Repository Path**: zhukelili/swagger-offline-doc

## Basic Information

- **Project Name**: swagger-offline-doc
- **Description**: 基于swagger2的离线pdf和html文档生成
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 14
- **Created**: 2018-12-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# swagger-offline-doc

#### 项目介绍
基于swagger2的离线pdf和html文档生成

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


#### 安装教程



#### 使用说明

1. 执行指令
 ```bash
 mvn clean test -Dtest=SwaggerStaticDocTest
 ```

生成的文档位于target/asciidoc目录下 分别为html以及pdf版本

2. 使用Application启动后可以访问swagger http://localhost:8079/swagger-offline-doc/swagger-ui.html

可以参考 [基于swagger2的离线pdf和html文档生成](https://my.oschina.net/qixiaobo025/blog/1921568)

#### 参与贡献

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


#### 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [http://git.mydoc.io/](http://git.mydoc.io/)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)

#### 测试结果
html呈现效果符合预期，pdf会出现词语中缺字的问题，效果较差

html效果：![输入图片说明](https://images.gitee.com/uploads/images/2018/1210/143241_6471a597_420512.png "`8XRX2JIU]N0$ISVA5@D`CJ.png")
pdf效果：![输入图片说明](https://images.gitee.com/uploads/images/2018/1210/143439_e0eb8237_420512.png "X8XAL1PC{@VJ)S]PID$[JHU.png")