# generate-delivery-doc

**Repository Path**: getStudyJava/generate-delivery-doc

## Basic Information

- **Project Name**: generate-delivery-doc
- **Description**: 生成接口（swagger）、数据库 word 文档
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-08-12
- **Last Updated**: 2022-08-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# generate-delivery-doc

## 介绍
生成接口（swagger）、数据库 word 文档。

注意：

`swagger` 解析仅支持 `3.0` 以上，请自行查看 `swagger json` 中的 `openapi` 版本。

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "后台端",
    "description": "后台端",
    "version": "1.0"
  },
  ...
}
```

## 目录结构

```
generate-delivery-doc
 ├── Dockerfile
 ├── pom.xml
 └── src
     └── main
         ├── java
         │   └── cn
         │       └── nn200433
         │           ├── common
         │           │   └── BaiDuFy.java                   百度翻译工具类
         │           ├── controller
         │           │   └── IndexController.java           控制层（页面 / 接口）
         │           ├── db                                 数据库文档生成
         │           │   ├── AbstractProcess.java
         │           │   ├── DataModelProcess.java
         │           │   ├── DbToWord.java
         │           │   └── entity
         │           │       └── DbParam.java
         │           ├── DocApplication.java                项目启动器
         │           └── swagger                            接口文档生成
         │               ├── entity
         │               │   ├── Endpoint.java
         │               │   ├── Parameter.java
         │               │   ├── Resource.java
         │               │   ├── SwaggerData.java
         │               │   └── SwaggerParam.java
         │               └── SwaggerToWord.java
         └── resources
             ├── application.yml                            SpringBoot 配置文件
             ├── db                                         数据库文档模板
             │   └── tpl_db.docx
             ├── logback-spring.xml                         输出日志配置文件
             ├── swagger                                    接口文档模板
             │   └── tpl_swagger.docx
             └── templates                                  UI界面
                 └── index.html
```

## 快速入门

1. 下载项目

```bash
git clone https://gitee.com/nn200433/generate-delivery-doc.git
```

2. 编译打包

```bash
mvn clean package -Dmaven.test.skip=true
```

3. 启动项目

```bash
# 定位到编译好的文件位置
cd <your root>/generate-delivery-doc/target
# 启动项目
java -jar generate-delivery-doc.jar
```

4. 本地访问 `http://127.0.0.1:8080/index`

## 截图

![界面 - swagger](doc/snipaste20220416_145904.jpg)

![生成 - swagger](doc/swagger.gif)

![文档 - swagger](doc/snipaste20220416_153104.jpg)

![界面 - db](doc/snipaste20220416_145942.jpg)

![生成 - db](doc/db.gif)

![文档 - db](doc/snipaste20220416_153739.jpg)

## 待办

> 不保证一定更新

- [ ] 自定义模板配置

## 特别鸣谢

> 感谢以下的项目,排名不分先后

* [Hutool](https://hutool.cn) Hutool是一个Java工具包，让Java语言也可以“甜甜的”。
* [screw](https://gitee.com/leshalv/screw) 简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。