Skip to content

A
appbuild
Switch branch/tag
Find file BlameHistoryPermalink
api.md.ftl 7.87 KB
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 
# 服务平台
版本 |  创建时间   | 作者 |  备注信息
---|---|---|---
v1.0|2022-01-20|zxfei| 接口文档

## 数据类型
类型名称|类型描述|参考样例
---|---|---
String |字符串|A、a、ab
Integer|数字类型|1、12、-1
Long|长整型数字|1、12、-1
date|时间类型,单位纳秒数字|167988745573
BigDecimal|小数类型|545.256
object|对象类型|{"name":"zhang3"}
arrays|数组类型|[{"name":"zhang3"},{"name":"zhang2"}]

<#list tableList as table>
## ${table.functionName}

### 查询${table.functionName}列表

**请求URL:** ${table.requestMapping}/list

**请求方式:** POST

**内容类型:** application/json;charset=utf-8

**简要描述:** 查询${table.functionName}

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:------
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
<#list table.columns as column>
    <#if column.isQuery == 1>
         <#if column.javaType=="String" >
${column.javaField}|${column.javaType}|否|${column.columnComment},字段前后添加%%模糊查询
            <#else>
${column.javaField}|${column.javaType}|否|${column.columnComment}
         </#if>
    </#if>
</#list>

**请求样例:**
```
  {
<#list table.columns as column>
    <#if column.isQuery == 1>
    <#if column.javaType=="String" ||column.javaType=="Date">
        <#assign fakeValue>"${column.randomStr(column.javaType)}"</#assign>
    <#else>
        <#assign fakeValue>${column.randomStr(column.javaType)}</#assign>
    </#if>
        "${column.javaField}":${fakeValue}<#sep>,</#sep>
    </#if>
</#list>
        "page":1,
        "size":10
  }

```
**响应参数:**

参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
&emsp;per_page|Integer|每页条数
&emsp;total|Integer|总条数
&emsp;last_page|Integer|总页数
&emsp;current_page|Integer|当前页
&emsp;data|array|结果集列表|数组
<#list table.columns as column>
&emsp;&emsp;${column.javaField}|${column.javaType}|${column.columnComment}
</#list>
dict|object|字典对象
<#list table.columns as column>
    <#if column.dict??&&(column.columnType?contains("tinyint") ||column.htmlType==3||column.htmlType==5)>
&emsp;${column.javaField}|object|字典属性对象，详见附录
    </#if>
</#list>

**响应消息样例:**
```
{
    "code":1,
    "data":{
    }
}
```

### 查看${table.functionName}

**请求URL:** ${table.requestMapping}/info

**请求方式:** GET

**内容类型:** application/json;charset=utf-8

**简要描述:** 查看${table.functionName}，返回实例详细信息

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:------
${table.pkColumn.javaField}|${table.pkColumn.javaType}|是|ID

**请求样例:**
```
    http://localhost/${table.requestMapping}/info?id=549
```
**响应参数:**

参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
<#list table.columns as column>
&emsp;${column.javaField}|${column.javaType}|${column.columnComment}
</#list>
dict|object|字典对象
<#list table.columns as column>
    <#if column.dict??&&(column.columnType?contains("tinyint") ||column.htmlType==3||column.htmlType==5)>
&emsp;${column.javaField}|object|字典属性对象，详见附录
    </#if>
</#list>

**响应消息样例:**
```
{
    "code": 1,
    "data": {
        <#list table.columns as column>
            <#if column.javaType=="String" ||column.javaType=="Date">
                <#assign fakeValue>"${column.randomStr(column.javaType)}"</#assign>
                <#else>
                <#assign fakeValue>${column.randomStr(column.javaType)}</#assign>
            </#if>
            "${column.javaField}":${fakeValue}<#sep>,</#sep>
        </#list>
        }
}
```

### 保存更新${table.functionName}

**请求URL:** ${table.requestMapping}/save

**请求方式:** POST

**内容类型:** application/json;charset=utf-8

**简要描述:** 保存或更新${table.functionName}：id为空时为新增保存，否则为更新提交

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:-------
<#list table.columns as column>
<#if !column.isSuperColumn(column.javaField)>
${column.javaField}|${column.javaType}|是|${column.columnComment}
</#if>
</#list>

**请求样例:**
```
{
<#list table.columns as column>
    <#if !column.isSuperColumn(column.javaField)>
        <#if column.javaType=="String" ||column.javaType=="Date">
            <#assign fakeValue>"${column.randomStr(column.javaType)}"</#assign>
            <#else>
            <#assign fakeValue>${column.randomStr(column.javaType)}</#assign>
        </#if>
    "${column.javaField}":${fakeValue}<#sep>,</#sep>
    </#if>
</#list>
}

```
**响应参数:**

参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
&emsp;id|Long|保存后主键id
&emsp;entity|object|保存更新实体
<#list table.columns as column>
&emsp;&emsp;${column.javaField}|${column.javaType}|${column.columnComment}
</#list>

**响应消息样例:**
```
{
    "msg":"新增模块成功",
    "code":1,
    "data":{}
    }
}

```

### 删除${table.functionName}

**请求URL:** ${table.requestMapping}/delete

**请求方式:** GET

**内容类型:** application/json;charset=utf-8

**简要描述:** 删除${table.functionName}

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:------
${table.pkColumn.javaField}|String|是|数组

**请求样例:**
```
    http://localhost:8080/${table.requestMapping}/delete?id=1&id=2'
```
**响应参数:**

参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-

**响应消息样例:**
```
{
    "code":1,
	"msg":"成功"
}

```
<#if table.isGenExport==1 >

### 导入${table.functionName}模板下载

**请求URL:** ${table.requestMapping}/downloadTemplate

**请求方式:** POST

**内容类型:** application/octet-stream;charset=utf-8

**简要描述:** ${table.functionName}导入模板下载

**请求样例:**
```
    http://localhost/${table.requestMapping}/downloadTemplate
```

**Response-example:**
```
...

```

### 导入${table.functionName}

**请求URL:** ${table.requestMapping}/importData

**请求方式:** POST

**内容类型:** multipart/form-data

**简要描述:** 导入${table.functionName}

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:------
file|file|是|文件流

**请求样例:**
```
    http://localhost/${table.requestMapping}/importData --data 'updateSupport=true'

```

**Response-example:**
```
...

```

### 导出${table.functionName}

**请求URL:** ${table.requestMapping}/exportExcel

**请求方式:** POST

**内容类型:** application/json;charset=utf-8

**简要描述:** 导出${table.functionName}

**请求参数:**

参数名称|类型|必填|描述
:---|:---|:---|:------
idList|Arrays|否|id数组
<#list table.columns as column>
    <#if column.isQuery == 1>
        ${column.javaField}|${column.javaType}|${column.columnComment}|否|参数查询条件
    </#if>
</#list>

**请求样例:**
```
{
    idList:[1,2],
<#list table.columns as column>
    <#if column.isQuery == 1>
        <#if column.javaType=="String" ||column.javaType=="Date">
            <#assign fakeValue>"${column.randomStr(column.javaType)}"</#assign>
        <#else>
            <#assign fakeValue>${column.randomStr(column.javaType)}</#assign>
        </#if>
        "${column.javaField}":${fakeValue}<#sep>,</#sep>
    </#if>
</#list>

}

```

**Response-example:**
```
...

```
</#if>
</#list>
## 字典附录
<#list tableList as table>
<#list table.columns as column>
<#if column.dict??>
    <#assign comment=column.subComment(column.columnComment) />
### ${column.javaField}
字典参数key|字典参数值|其它
:---|:---|:---
<#list column.dict as dict>
${dict.num}|${dict.value}|-
</#list>
</#if>
</#list>
</#list>