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
| {
| "serverUrl": "", // https://www.huiwuyuntong.com/baodianapi 服务器地址,非必须。导出postman建议设置成http://{{server}}方便直接在postman直接设置环境变量
| "outPath": "./src/main/resources/static/doc", // 指定文档的输出路径,相对路径时请用./开头，eg:./src/main/resources/static/doc
| "allInOne": true, //是否将文档合并到一个文件中，一般推荐为true
| "allInOneDocFileName":"index.html",//自定义设置输出文档名称, @since 1.9.0
| "style": "vs2015",
| "createDebugPage": true, //@since 2.0.0 smart-doc支持创建可以测试的html页面，仅在AllInOne模式中起作用。
| "packageFilters": "com.nanjing.water.host.controller.*,com.nanjing.water.host.admin.*,com.nanjing.water.host.controller.pay.*",//controller包过滤，多个包用英文逗号隔开，2.2.2开始需要采用正则：com.test.controller.*
| "requestExample":"true",//是否将请求示例展示在文档中，默认true，@since 1.9.0
| "responseExample":"true",//是否将响应示例展示在文档中，默认为true，@since 1.9.0
| // "requestHeaders": [{ //设置请求头，没有需求可以不设置
| // "name": "Token",//请求头名称
| // "type": "string",//请求头类型
| // "desc": "登录后的身份令牌",//请求头描述信息
| // "value":"123456",//不设置默认null
| // "required": true,//是否必须
| // "since": "-", //什么版本添加的改请求头
| // //"pathPatterns": "/app/test/**",//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求头高级配置?sort_id=4178978
| // "excludePathPatterns":"/file/**,/admin/user/login"//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求头高级配置?sort_id=4178978
| // }],
| "dataDictionaries": [{
| "title": "EResultCode - 请求响应状态码",
| "enumClassName": "com.nanjing.water.common.enums.EResultCode",
| "codeField": "code",
| "descField": "message"
| },{
| "title": "ESex - 性别",
| "enumClassName": "com.nanjing.water.entity.enums.ESex",
| "codeField": "value",
| "descField": "desc"
| }, {
| "title": "EState - 状态",
| "enumClassName": "com.nanjing.water.entity.enums.EState",
| "codeField": "value",
| "descField": "desc"
| }, {
| "title": "EParameterType - 参数类型",
| "enumClassName": "com.nanjing.water.entity.enums.EParameterType",
| "codeField": "value",
| "descField": "desc"
| }, {
| "title": "EUserType - 用户类型",
| "enumClassName": "com.nanjing.water.entity.enums.EUserType",
| "codeField": "value",
| "descField": "desc"
| },
|
|
|
| // 排序的枚举，为了便于阅读请放在字典列表的最后。业务枚举放在前面
| {
| "title": "EOrderBy - 通用查询-排序支持的字段枚举",
| "enumClassName": "com.nanjing.water.entity.enums.EOrderBy",
| "codeField": "value",
| "descField": "desc"
| }, {
| "title": "ESortOrderBy - 排序类型带排序值字段",
| "enumClassName": "com.nanjing.water.entity.enums.ESortOrderBy",
| "codeField": "value",
| "descField": "desc"
| }
| ]
| }
|
|
