# api-docs-gen

**Repository Path**: iogogogo/api-docs-gen

## Basic Information

- **Project Name**: api-docs-gen
- **Description**: 根据swagger生成离线md文档
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-08
- **Last Updated**: 2023-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档生成工具

支持将swagger文档转换成其他格式的接口文档，比如Markdown、word、pdf版本

# 更新文档版本
```shell
sed -i 's/"version":"123"/"version":"v4.7.5"/' refiner-v4.7.1.json
```

1. 安装 `Java8+` 环境
2. 修改 `application.properties` 配置文件，修改对应的 `swagger` 地址
3. `java -jar api-docs-gen-1.0.0.jar` 生成配置文件
4. 获取md文件，转换成需要的格式，word或者pdf



```shell
➜  api-docs-gen-1.0.0 ll
total 46200
-rw-r--r--  1 tao.zeng  staff    23M  4  7 10:04 api-docs-gen-1.0.0.jar
-rw-r--r--  1 tao.zeng  staff   100B  4  7 10:19 application.properties
drwxr-xr-x  3 tao.zeng  staff    96B  4  7 10:19 asciidoc
➜  api-docs-gen-1.0.0
➜  api-docs-gen-1.0.0 tree -L 3
.
├── api-docs-gen-1.0.0.jar
├── application.properties
└── asciidoc
    └── docs
        ├── refiner-restful-v4.7.adoc
        ├── refiner-restful-v4.7.md
        └── refiner-restful-v4.7.txt

2 directories, 5 files

```


## 其它
1. 如需要html版本，需要先生成adoc文件，然后编译项目执行`./build.sh`，获取html文件
```shell
➜  api-docs-gen git:(master) ✗ tree asciidoc -L 2
asciidoc
├── docs
│   ├── refiner-restful-v5.0.adoc
│   ├── refiner-restful-v5.0.md
│   └── refiner-restful-v5.0.txt
└── target
    ├── refiner-restful-v5.0.html
    ├── refiner-restful-v5.0.md
    └── refiner-restful-v5.0.txt

3 directories, 6 files

```