smart-doc生成接口文档

words: 5.6k    views:    time: 30min
日常随笔
smart-doc

smart-doc是一款支持Java Rest Api和Apache Dubbo Rpc接口文档生成的工具，官方文档已经介绍得很好，就不过多赘述了。相比swagger基于注解生成接口文档，它基于注释来生成，将代码无侵入这一目标进行的更加彻底，生成的接口文档画风也非常简单干净，而且支持JSR-303规范，可以解析Validation API相关的参数校验。这里记录一下在springboot应用中通过maven插件来生成smart接口文档的具体实践。

官网文档：https://smart-doc-group.github.io/#/zh-cn/?id=smart-doc

示例

  • maven插件

对于smart插件的配置，包括指定配置文件路径，生成目标的格式，比如html

pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<build>
    <plugins>
        <plugin>
            <groupId>com.github.shalousun</groupId>
            <artifactId>smart-doc-maven-plugin</artifactId>
            <version>2.4.7</version>
            <executions>
                <execution>
                    <phase>compile</phase> 
                    <goals>
                        <goal>html</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <configFile>./src/main/resources/smart-doc.json</configFile>
            </configuration>
        </plugin>
    </plugins>
</build>
  • smart配置

以下是我们采用的一份应用配置，参考官方文档有更详细的示例。

resources/smart-doc.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
    "serverUrl": "http://localhost:8080",
    "pathPrefix": "/admin",
    "openUrl": "http://192.168.141.13:7700/api",        ## Tornal地址
    "appToken": "7d0a662f24f742f1980d48f7adc4c798",     ## Tornal应用Token
    "debugEnvName": "Dev",
    "debugEnvUrl": "http://localhost:8080",
    "tornaDebug": false,
    "replace": true,
    "isStrict": false,
    "allInOne": true,
    "allInOneDocFileName": "index.html",
    "style": "atelier_cave-light",
    "outPath": "target/classes/static/doc",
    "coverOld": true,
    "createDebugPage": true,
    "packageFilters": "com.xxx.*",
    "requestHeaders": [
        {
            "name": "Authorization",
            "type": "string",
            "value": "-",
            "desc": "请求Token",
            "required": false,
            "since": "1.0.0"
        },
        {
            "name": "requestId",
            "type": "string",
            "value": "xxx20220321",
            "desc": "请求Id",
            "required": false,
            "since": "1.0.0"
        },
        {
            "name": "Accept-Language",
            "type": "string",
            "value": "en",
            "desc": "国际化 en/zh",
            "required": false,
            "since": "1.0.0"
        }
    ],
    "errorCodeDictionaries": [
        {
            "title": "响应码",
            "enumClassName": "org.springframework.feign.codec.ResponseCode",
            "codeField": "code",
            "descField": "desc"
        }
    ],
    "dataDictionaries": [

    ],
    "revisionLogs": [
        {
            "version": "1.0.0",
            "revisionTime": "2022-03-21",
            "status": "create",
            "author": "shanhuiming",
            "remarks": "-"
        }
    ]
}

Torna对接

关于Torna平台，我们感觉最受用的是它导出的word文档，对于排版和样式做的比较好，远好于直接通过swagger或smart到出来的word。在Torna上创建对应的项目，找到OpenApi下面的token，并添加到上面的配置中，然后执行目标mvn smart-doc:torna-rest就可以将接口文档上传到Torna平台了。

具体的可以使用docker-compose方式部署（依赖Mysql），可以参考：https://gitee.com/durcframework/torna/tree/master/torna-docker-compose

docker-compose.yaml
1
2
3
4
5
6
7
8
9
10
11
12
version: "3"
services:
  torna:
    image: registry.cn-hangzhou.aliyuncs.com/tanghc/torna:latest
    container_name: torna
    ports:
      - 7700:7700
    volumes:
      - ./torna/application.properties:/torna/config/application.properties
    environment:
      - TZ=Asia/Shanghai
      - JAVA_OPTS=-server -Xmx512m -Xms512m -Djava.awt.headless=true

至于Torna的配置文件

application.properties
1
2
3
4
5
6
7
8
9
10
# Server port
server.port=7700

# MySQL host
mysql.host=${MYSQL_HOST:localhost:3306}
# Schema name
mysql.schema=${MYSQL_SCHEMA:torna}
# Make sure the account can run CREATE/ALTER SQL
mysql.username=${MYSQL_USERNAME:torna}
mysql.password=${MYSQL_PASSWORD:123456}

附录

Torna数据库的初始化sql

Torna.sql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
-- 适用于MySQL5.6.5+ (5.5.3开始支持utf8mb4，5.6.5开始支持CURRENT_TIMESTAMP(datetime))
-- 导出 torna 的数据库结构
CREATE DATABASE IF NOT EXISTS `torna` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
USE `torna`;

DROP TABLE IF EXISTS `compose_additional_page`;
CREATE TABLE IF NOT EXISTS `compose_additional_page` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `project_id` bigint(20) unsigned NOT NULL COMMENT 'compose_project.id',
    `title` varchar(64) NOT NULL COMMENT '文档标题',
    `content` text COMMENT '文档内容',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序值',
    `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '1:启用，0：禁用',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_projectid` (`project_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='聚合文档附加页';

DROP TABLE IF EXISTS `compose_common_param`;
CREATE TABLE IF NOT EXISTS `compose_common_param` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT '唯一id，md5(doc_id:parent_id:style:name)',
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '字段名称',
    `type` varchar(64) NOT NULL DEFAULT 'String' COMMENT '字段类型',
    `required` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否必须，1：是，0：否',
    `max_length` varchar(64) NOT NULL DEFAULT '-' COMMENT '最大长度',
    `example` varchar(1024) NOT NULL DEFAULT '' COMMENT '示例值',
    `description` text NOT NULL COMMENT '描述',
    `enum_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'enum_info.id',
    `compose_project_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'compose_project.id',
    `parent_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `style` tinyint(4) NOT NULL DEFAULT '0' COMMENT '0：path, 1：header， 2：请求参数，3：返回参数，4：错误码',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_dataid` (`data_id`) USING BTREE,
    KEY `idx_compose_project_id` (`compose_project_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='聚合文档公共参数';

DROP TABLE IF EXISTS `compose_doc`;
CREATE TABLE IF NOT EXISTS `compose_doc` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `doc_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'doc_info.id',
    `project_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'compose_project.id',
    `is_folder` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否文件夹',
    `folder_name` varchar(64) NOT NULL DEFAULT '' COMMENT '文件夹名称',
    `parent_id` bigint(20) NOT NULL DEFAULT '0',
    `origin` varchar(128) NOT NULL DEFAULT '' COMMENT '文档来源',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `creator` varchar(64) NOT NULL DEFAULT '' COMMENT '创建人',
    `order_index` int(10) unsigned NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_projectid` (`project_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='文档引用';

DROP TABLE IF EXISTS `compose_project`;
CREATE TABLE IF NOT EXISTS `compose_project` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '项目名称',
    `description` varchar(128) NOT NULL DEFAULT '' COMMENT '项目描述',
    `space_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '所属空间，space.id',
    `type` tinyint(4) NOT NULL DEFAULT '1' COMMENT '访问形式，1：公开，2：加密',
    `password` varchar(64) NOT NULL DEFAULT '' COMMENT '访问密码',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '创建者userid',
    `creator_name` varchar(64) NOT NULL DEFAULT '',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `modifier_name` varchar(64) NOT NULL DEFAULT '',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `show_debug` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否显示调试',
    `gateway_url` varchar(128) NOT NULL DEFAULT '' COMMENT '网关url',
    `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '1：有效，0：无效',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_spaceid` (`space_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='组合项目表';

DROP TABLE IF EXISTS `constant_info`;
CREATE TABLE IF NOT EXISTS `constant_info` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `project_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'project.id',
    `module_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'module.id',
    `doc_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'doc_info.id',
    `content` text NOT NULL COMMENT '内容',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_projectid` (`project_id`) USING BTREE,
    KEY `idx_moduleid` (`module_id`) USING BTREE,
    KEY `idx_docid` (`doc_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COMMENT='常量信息';

DROP TABLE IF EXISTS `doc_info`;
CREATE TABLE IF NOT EXISTS `doc_info` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT '唯一id，接口规则：md5(module_id:parent_id:url:http_method)。分类规则：md5(module_id:parent_id:name)',
    `md5` varchar(32) NOT NULL DEFAULT '' COMMENT '文档内容的md5值',
    `name` varchar(128) NOT NULL DEFAULT '' COMMENT '文档名称',
    `description` text COMMENT '文档描述',
    `author` varchar(64) NOT NULL DEFAULT '' COMMENT '维护人',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '0:http,1:dubbo',
    `url` varchar(256) NOT NULL DEFAULT '' COMMENT '访问URL',
    `http_method` varchar(12) NOT NULL DEFAULT '' COMMENT 'http方法',
    `content_type` varchar(128) NOT NULL DEFAULT '' COMMENT 'contentType',
    `deprecated` varchar(128) DEFAULT '$false$' COMMENT '废弃信息',
    `is_folder` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否是分类，0：不是，1：是',
    `parent_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '父节点',
    `module_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '模块id，module.id',
    `is_use_global_headers` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否使用全局请求参数',
    `is_use_global_params` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否使用全局请求参数',
    `is_use_global_returns` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否使用全局返回参数',
    `is_request_array` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否请求数组',
    `is_response_array` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否返回数组',
    `request_array_type` varchar(16) NOT NULL DEFAULT 'object' COMMENT '请求数组时元素类型',
    `response_array_type` varchar(16) NOT NULL DEFAULT 'object' COMMENT '返回数组时元素类型',
    `create_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '新增操作方式，0：人工操作，1：开放平台推送',
    `modify_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '修改操作方式，0：人工操作，1：开放平台推送',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '创建人',
    `creator_name` varchar(64) NOT NULL DEFAULT '' COMMENT '创建者昵称user_info.nickname',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '修改人',
    `modifier_name` varchar(64) NOT NULL DEFAULT '' COMMENT '创建者昵称user_info.realname',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `remark` text COMMENT '备注',
    `is_show` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否显示',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `is_locked` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否锁住',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_data_id` (`data_id`) USING BTREE,
    KEY `idx_moduleid` (`module_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=103 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='文档信息';

DROP TABLE IF EXISTS `doc_param`;
CREATE TABLE IF NOT EXISTS `doc_param` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT '唯一id，md5(doc_id:parent_id:style:name)',
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '字段名称',
    `type` varchar(64) NOT NULL DEFAULT 'String' COMMENT '字段类型',
    `required` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否必须，1：是，0：否',
    `max_length` varchar(64) NOT NULL DEFAULT '-' COMMENT '最大长度',
    `example` varchar(1024) NOT NULL DEFAULT '' COMMENT '示例值',
    `description` text NOT NULL COMMENT '描述',
    `enum_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'enum_info.id',
    `doc_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'doc_info.id',
    `parent_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `style` tinyint(4) NOT NULL DEFAULT '0' COMMENT '0：path, 1：header， 2：body参数，3：返回参数，4：错误码, 5：query参数',
    `create_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '新增操作方式，0：人工操作，1：开放平台推送',
    `modify_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '修改操作方式，0：人工操作，1：开放平台推送',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `creator_name` varchar(64) NOT NULL DEFAULT '',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `modifier_name` varchar(64) NOT NULL DEFAULT '',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_dataid` (`data_id`) USING BTREE,
    KEY `idx_docid` (`doc_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=733 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='文档参数';

DROP TABLE IF EXISTS `enum_info`;
CREATE TABLE IF NOT EXISTS `enum_info` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT '唯一id，md5(module_id:name)',
    `name` varchar(128) NOT NULL DEFAULT '' COMMENT '枚举名称',
    `description` varchar(128) NOT NULL DEFAULT '' COMMENT '枚举说明',
    `module_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'module.id',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_moduleid` (`module_id`) USING BTREE,
    KEY `idx_dataid` (`data_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='枚举信息';

DROP TABLE IF EXISTS `enum_item`;
CREATE TABLE IF NOT EXISTS `enum_item` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `enum_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'enum_info.id',
    `name` varchar(128) NOT NULL DEFAULT '' COMMENT '名称，字面值',
    `type` varchar(64) NOT NULL DEFAULT '' COMMENT '类型',
    `value` varchar(64) NOT NULL DEFAULT '' COMMENT '枚举值',
    `description` varchar(128) NOT NULL DEFAULT '' COMMENT '枚举描述',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_enumid` (`enum_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='枚举详情';

DROP TABLE IF EXISTS `mock_config`;
CREATE TABLE IF NOT EXISTS `mock_config` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '名称',
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT 'md5(path+query+body)',
    `path` varchar(128) NOT NULL DEFAULT '',
    `ip` varchar(64) NOT NULL DEFAULT '' COMMENT '过滤ip',
    `request_data` text NOT NULL COMMENT '请求参数',
    `request_data_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '参数类型，0：KV形式，1：json形式',
    `http_status` int(11) NOT NULL DEFAULT '200' COMMENT 'http状态',
    `delay_mills` int(11) NOT NULL DEFAULT '0' COMMENT '延迟时间，单位毫秒',
    `result_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '返回类型，0：自定义内容，1：脚本内容',
    `response_headers` text NOT NULL COMMENT '响应header，数组结构',
    `response_body` text NOT NULL COMMENT '响应结果',
    `mock_script` text COMMENT 'mock脚本',
    `mock_result` text COMMENT 'mock结果',
    `doc_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '文档id',
    `remark` varchar(128) NOT NULL DEFAULT '' COMMENT '备注',
    `creator_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '创建人id',
    `creator_name` varchar(64) NOT NULL DEFAULT '' COMMENT '创建人姓名',
    `modifier_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '修改人id',
    `modifier_name` varchar(64) DEFAULT NULL COMMENT '修改人',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_docid` (`doc_id`) USING BTREE,
    KEY `idx_dataid` (`data_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='mock配置';

DROP TABLE IF EXISTS `module`;
CREATE TABLE IF NOT EXISTS `module` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '模块名称',
    `project_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'project.id',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '模块类型，0：自定义添加，1：swagger导入，2：postman导入',
    `import_url` varchar(128) NOT NULL DEFAULT '' COMMENT '导入url',
    `basic_auth_username` varchar(128) NOT NULL DEFAULT '' COMMENT 'basic认证用户名',
    `basic_auth_password` varchar(128) NOT NULL DEFAULT '' COMMENT 'basic认证密码',
    `token` varchar(128) NOT NULL DEFAULT '' COMMENT '开放接口调用token',
    `create_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '新增操作方式，0：人工操作，1：开放平台推送',
    `modify_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '修改操作方式，0：人工操作，1：开放平台推送',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_token` (`token`) USING BTREE,
    KEY `idx_projectid` (`project_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='项目模块';

DROP TABLE IF EXISTS `module_config`;
CREATE TABLE IF NOT EXISTS `module_config` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `module_id` bigint(11) unsigned NOT NULL DEFAULT '0',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '配置类型，1：全局header',
    `config_key` varchar(128) NOT NULL DEFAULT '' COMMENT '配置key',
    `config_value` varchar(128) NOT NULL DEFAULT '' COMMENT '配置值',
    `extend_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `description` varchar(256) NOT NULL DEFAULT '' COMMENT '描述',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_moduleid_type` (`module_id`,`type`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='系统配置';

DROP TABLE IF EXISTS `module_environment`;
CREATE TABLE IF NOT EXISTS `module_environment` (
    `id` bigint(20) NOT NULL AUTO_INCREMENT,
    `module_id` bigint(20) NOT NULL COMMENT 'module.id',
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '环境名称',
    `url` varchar(255) NOT NULL DEFAULT '' COMMENT '调试路径',
    `is_public` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否公开',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `uk_moduleid_name` (`module_id`,`name`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='模块调试环境';

DROP TABLE IF EXISTS `module_environment_param`;
CREATE TABLE IF NOT EXISTS `module_environment_param` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT '唯一id，md5(doc_id:parent_id:style:name)',
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '字段名称',
    `type` varchar(64) NOT NULL DEFAULT 'String' COMMENT '字段类型',
    `required` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否必须，1：是，0：否',
    `max_length` varchar(64) NOT NULL DEFAULT '-' COMMENT '最大长度',
    `example` varchar(1024) NOT NULL DEFAULT '' COMMENT '示例值',
    `description` text NOT NULL COMMENT '描述',
    `enum_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'enum_info.id',
    `environment_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'module_environment.id',
    `parent_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `style` tinyint(4) NOT NULL DEFAULT '0' COMMENT '0：path, 1：header， 2：请求参数，3：返回参数，4：错误码',
    `create_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '新增操作方式，0：人工操作，1：开放平台推送',
    `modify_mode` tinyint(4) NOT NULL DEFAULT '0' COMMENT '修改操作方式，0：人工操作，1：开放平台推送',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `creator_name` varchar(64) NOT NULL DEFAULT '',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `modifier_name` varchar(64) NOT NULL DEFAULT '',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_dataid` (`data_id`) USING BTREE,
    KEY `idx_environmentid` (`environment_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='模块公共参数';

DROP TABLE IF EXISTS `module_swagger_config`;
CREATE TABLE IF NOT EXISTS `module_swagger_config` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键id',
    `module_id` bigint(20) NOT NULL COMMENT 'module.id',
    `url` varchar(256) NOT NULL DEFAULT '' COMMENT 'swagger url',
    `content` longtext NOT NULL COMMENT 'swagger内容',
    `auth_username` varchar(128) NOT NULL DEFAULT '' COMMENT '认证用户名',
    `auth_password` varchar(128) NOT NULL DEFAULT '' COMMENT '认证密码',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    KEY `idx_moduleid` (`module_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='swagger配置表';

DROP TABLE IF EXISTS `open_user`;
CREATE TABLE IF NOT EXISTS `open_user` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `app_key` varchar(100) NOT NULL COMMENT 'appKey',
    `secret` varchar(200) DEFAULT NULL COMMENT 'secret',
    `status` tinyint(4) unsigned NOT NULL DEFAULT '1' COMMENT '1启用，0禁用',
    `applicant` varchar(64) NOT NULL DEFAULT '',
    `space_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'space.id',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_app_key` (`app_key`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='开放用户';

DROP TABLE IF EXISTS `project`;
CREATE TABLE IF NOT EXISTS `project` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '项目名称',
    `description` varchar(128) NOT NULL DEFAULT '' COMMENT '项目描述',
    `space_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '所属空间，space.id',
    `is_private` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否私有项目，1：是，0：否',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '创建者userid',
    `creator_name` varchar(64) NOT NULL DEFAULT '',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0',
    `modifier_name` varchar(64) NOT NULL DEFAULT '',
    `order_index` int(11) NOT NULL DEFAULT '0' COMMENT '排序索引',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `uk_name` (`creator_id`,`name`) USING BTREE,
    KEY `idx_spaceid` (`space_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='项目表';

DROP TABLE IF EXISTS `project_user`;
CREATE TABLE IF NOT EXISTS `project_user` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `project_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'project.id',
    `user_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'user_info.id',
    `role_code` varchar(64) NOT NULL DEFAULT '0' COMMENT '角色，guest：访客，dev：开发者，admin：项目管理员',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_projectid_userid` (`project_id`,`user_id`) USING BTREE,
    KEY `idx_userid` (`user_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='项目用户关系表';

DROP TABLE IF EXISTS `prop`;
CREATE TABLE IF NOT EXISTS `prop` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `ref_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '关联id',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '类型，0：doc_info属性',
    `name` varchar(64) NOT NULL DEFAULT '',
    `val` text NOT NULL,
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_docid_name` (`ref_id`,`type`,`name`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='属性表';

DROP TABLE IF EXISTS `push_ignore_field`;
CREATE TABLE IF NOT EXISTS `push_ignore_field` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `module_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'module.id',
    `data_id` varchar(64) NOT NULL DEFAULT '' COMMENT 'doc_info.data_id',
    `field_name` varchar(64) NOT NULL DEFAULT '' COMMENT 'doc_info.name',
    `field_description` varchar(64) NOT NULL DEFAULT '' COMMENT '字段描述',
    `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_moduleid_dataid_fieldname` (`module_id`,`data_id`,`field_name`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='推送忽略字段';

DROP TABLE IF EXISTS `share_config`;
CREATE TABLE IF NOT EXISTS `share_config` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '分享形式，1：公开，2：加密',
    `password` varchar(128) NOT NULL DEFAULT '' COMMENT '密码',
    `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '状态，1：有效，0：无效',
    `module_id` bigint(20) NOT NULL DEFAULT '0' COMMENT 'module.id',
    `is_all` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否为全部文档',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `remark` varchar(128) NOT NULL DEFAULT '' COMMENT '备注',
    `creator_name` varchar(64) NOT NULL DEFAULT '' COMMENT '创建人',
    `is_show_debug` tinyint(4) NOT NULL DEFAULT '1' COMMENT '是否显示调试',
    `is_all_selected_debug` tinyint(4) NOT NULL DEFAULT '1' COMMENT '调试环境是否全选， 1-全选， 0-不选',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_moduleid` (`module_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='分享配置表';

DROP TABLE IF EXISTS `share_content`;
CREATE TABLE IF NOT EXISTS `share_content` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `share_config_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'share_config.id',
    `doc_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '文档id',
    `parent_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '父id',
    `is_share_folder` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否分享整个分类',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_shareconfigid_docid` (`share_config_id`,`doc_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='分享详情';

DROP TABLE IF EXISTS `share_environment`;
CREATE TABLE IF NOT EXISTS `share_environment` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `share_config_id` bigint(20) unsigned DEFAULT '0' COMMENT '分享配置id',
    `module_environment_id` bigint(20) unsigned DEFAULT '0' COMMENT '模块环境id',
    PRIMARY KEY (`id`),
    KEY `share_environment_share_config_id_index` (`share_config_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='分享环境关联表';

DROP TABLE IF EXISTS `space`;
CREATE TABLE IF NOT EXISTS `space` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '空间名称',
    `creator_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '创建者userid',
    `creator_name` varchar(64) NOT NULL DEFAULT '',
    `modifier_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '创建者userid',
    `modifier_name` varchar(64) NOT NULL DEFAULT '',
    `is_compose` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否组合空间',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=21 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='分组表';

INSERT INTO `space` (`id`, `name`, `creator_id`, `creator_name`, `modifier_id`, `modifier_name`, `is_compose`, `is_deleted`, `gmt_create`, `gmt_modified`) VALUES
(20, '研发中心', 16, '超级管理员', 16, '超级管理员', 0, 0, '2022-11-03 20:24:59', '2022-11-03 20:24:59');

DROP TABLE IF EXISTS `space_user`;
CREATE TABLE IF NOT EXISTS `space_user` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `user_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'user_info.id',
    `space_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'space.id',
    `role_code` varchar(64) NOT NULL DEFAULT '' COMMENT '角色，guest：访客，dev：开发者，admin：空间管理员',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_groupid_userid` (`space_id`,`user_id`) USING BTREE,
    KEY `idx_userid` (`user_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=27 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='分组用户关系表';

INSERT INTO `space_user` (`id`, `user_id`, `space_id`, `role_code`, `is_deleted`, `gmt_create`, `gmt_modified`) VALUES
(26, 16, 20, 'admin', 0, '2022-11-03 20:24:59', '2022-11-03 20:24:59');

DROP TABLE IF EXISTS `system_config`;
CREATE TABLE IF NOT EXISTS `system_config` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `config_key` varchar(64) NOT NULL DEFAULT '',
    `config_value` varchar(256) NOT NULL DEFAULT '',
    `remark` varchar(128) NOT NULL DEFAULT '',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_configkey` (`config_key`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='系统配置表';

INSERT INTO `system_config` (`id`, `config_key`, `config_value`, `remark`, `is_deleted`, `gmt_create`, `gmt_modified`) VALUES
(3, 'torna.version', '11800', '当前内部版本号。不要删除这条记录！！', 0, '2022-11-03 20:20:53', '2022-11-03 20:20:53');

DROP TABLE IF EXISTS `user_dingtalk_info`;
CREATE TABLE IF NOT EXISTS `user_dingtalk_info` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `nick` varchar(64) NOT NULL DEFAULT '' COMMENT '用户在钉钉上面的昵称',
    `name` varchar(64) NOT NULL DEFAULT '' COMMENT '员工名称。',
    `email` varchar(128) NOT NULL DEFAULT '' COMMENT '员工邮箱。',
    `userid` varchar(128) NOT NULL DEFAULT '' COMMENT '员工的userid。',
    `unionid` varchar(128) NOT NULL DEFAULT '' COMMENT '用户在当前开放应用所属企业的唯一标识。',
    `openid` varchar(128) NOT NULL DEFAULT '' COMMENT '用户在当前开放应用内的唯一标识。',
    `user_info_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'user_info.id',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_unionid` (`unionid`) USING BTREE,
    KEY `idx_openid` (`openid`) USING BTREE,
    KEY `idx_userid` (`user_info_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='钉钉开放平台用户';

DROP TABLE IF EXISTS `user_info`;
CREATE TABLE IF NOT EXISTS `user_info` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `username` varchar(128) NOT NULL DEFAULT '' COMMENT '登录账号/邮箱',
    `password` varchar(128) NOT NULL DEFAULT '' COMMENT '登录密码',
    `nickname` varchar(64) NOT NULL DEFAULT '' COMMENT '昵称',
    `is_super_admin` tinyint(4) NOT NULL DEFAULT '0' COMMENT '是否是超级管理员',
    `source` varchar(64) NOT NULL DEFAULT 'register',
    `email` varchar(128) NOT NULL DEFAULT '',
    `status` tinyint(4) NOT NULL DEFAULT '1' COMMENT '0：禁用，1：启用，2：重设密码',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_username` (`username`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=17 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='用户表';

INSERT INTO `user_info` (`id`, `username`, `password`, `nickname`, `is_super_admin`, `source`, `email`, `status`, `is_deleted`, `gmt_create`, `gmt_modified`) VALUES
(16, 'admin', 'f9560048604e55186198a4a02ba1b9a9', '超级管理员', 1, 'register', '', 1, 0, '2022-11-03 20:20:53', '2022-11-03 20:20:53');

DROP TABLE IF EXISTS `user_message`;
CREATE TABLE IF NOT EXISTS `user_message` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `user_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'user_info.id',
    `message` varchar(256) NOT NULL DEFAULT '',
    `is_read` tinyint(4) NOT NULL DEFAULT '0',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '同user_subscribe.type',
    `source_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '同user_subscribe.source_id',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    KEY `idx_userid` (`user_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='站内消息';

DROP TABLE IF EXISTS `user_subscribe`;
CREATE TABLE IF NOT EXISTS `user_subscribe` (
    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
    `user_id` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT 'user_info.id',
    `type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '类型，1：订阅接口，2：订阅项目',
    `source_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '关联id，当type=1对应doc_info.id；type=2对应project.id',
    `is_deleted` tinyint(4) NOT NULL DEFAULT '0',
    `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP,
    `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`) USING BTREE,
    UNIQUE KEY `uk_userid_type_sourceid` (`user_id`,`type`,`source_id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=9 DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC COMMENT='用户订阅表';


参考：