数据类型
API操作定义的数据类型使用Swagger规范，并在此基础上做了一些扩展：
标准类型
在API定义中使用下表中的
Common Name作为数据类型的name
| Common Name | type |
format |
Comments | |
|---|---|---|---|---|
| integer | integer |
int32 |
signed 32 bits | |
| long | integer |
int64 |
signed 64 bits | |
| float | number |
float |
||
| double | number |
double |
||
| string | string |
|||
| byte | string |
byte |
base64 encoded characters | |
| binary | string |
binary |
any sequence of octets | |
| boolean | boolean |
|||
| date | string |
date |
As defined by full-date - RFC3339 |
|
| dateTime | string |
date-time |
As defined by date-time - RFC3339 |
|
| password | string |
password |
Used to hint UIs the input needs to be obscured. |
扩展类型
| Common Name | type |
format |
Comments |
|---|---|---|---|
| int | integer |
int32 |
标准类型中integer的别名 |
| object | object |
相当于map<string,object> | |
| map | object |
相当于map<string,object> | |
| map<string,{type}> | object |
明确指定map的值类型 |
|
| array | array |
数组类型，相当于array<object> | |
| array<{type}> | array |
数组类型，并明确指定数组元素的类型 |
引用类型
使用type={Referenced Name}可以直接应用app/{Entity}.json或者app/{Model}.json中的类型。
数组类型
也可称为集合类型
在类型名称后加上[]，如string[]，也可以用下面扩展类型中的array<string>来表示。
文件类型
文件上传使用file表示，jmms会自动设置对应的其他参数，详细请看 swagger 规范文档。
下面是swagger规范的原文：
If type is "file", the consumes MUST be either "multipart/form-data",
"application/x-www-form-urlencoded" or both and the parameter MUST be in "formData".
上一篇：@returns-include
下一篇：参考:location