模型定义
模型定义类似实体定义,通过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 属性 |