# swagger2Doc

**Repository Path**: ProSayJ/swagger2Doc

## Basic Information

- **Project Name**: swagger2Doc
- **Description**: 将swagger.json格式的文档转成html和pdf格式的静态文档
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-04-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gradle工程将swagger文档转成html和pdf格式的静态文档 

#### 介绍
本人开发使用gradle工具构建工程，在使用swagger时,需要生成api静态文档，但参考网上的许多教程，但效果都不是很理想。
故自己整理了一个文档生成工程,不敢独享。希望能帮助这方面需求的开发者，少走些坑。


#### 使用说明

> 本人的开发环境是mac电脑

0. [安装`ascilldoctor`编译环境](https://asciidoctor.org/)
1. 将本工程下载到本地,并将自己的`swagger.json`文档文件拷贝到根目录下
2. 打开`build.gradle`文件，点击`asciidoctor`运行生成文档，或者在命令行中执行`sh gradlew asciidoctor `
3. 执行成功后，结果会生成在`build/asciidoc`文件夹下
4. 根据asciidoc语法开发者也可以扩展文档内容,文档目录在`src/asciidoc` 

#### 问题

1. pdf文档中文显示不全解决办法

   1. 在gradle仓库中找到`asciidoctorj-pdf-1.5.0-alpha.16.jar`文件，文件的默认位置为`/Users/xxx/.gradle/caches/modules-2/files-2.1/org.asciidoctor/asciidoctorj-pdf/1.5.0-alpha.16/xxx`
   2. 将工程下的`lib/asciidoctorj-pdf-1.5.0-alpha.16.jar`替换掉仓库中的相应jar就可以了