模型定义
模型定义类似实体定义,通过className指定对应的Model Class。
Example:
- 创建
com.example.project.model.Query.java类:
package com.example.project.model;
public class Query {
protected Integer limit;
protected Integer offset;
protected String where;
protected String orderBy;
...
}
- 创建
app/models/Query.json文件:
{
"className": "com.example.project.model.Query"
}
默认情况下所有的java bean property都成为api model proerty。
您也可以使用@ApiModel和@ApiProperty两个Annotation进行个性化定义。
@ApiModel
class: leap.web.api.annotation.ApiModel
| Field | Desc |
|---|---|
| value | 定义Api Model的Name(name的别名) |
| name | 定义Api Model的Name |
| desc | 定义Api Model的描述 |
| explicitProperties | 当设置为true时,Java类里的属性需要标注@ApiProperty才能成为Api Model的Property |
@ApiProperty
class: leap.web.api.annotation.ApiProperty
| Field | Desc |
|---|---|
| value | 定义Api Property的Name(name的别名) |
| name | 定义Api Property的Name |
| desc | 定义Api Property的描述 |
| required | 定义Api Property的required属性 |
| readOnly | 定义Api Property的readOnly属性 |