Commit 3a7e382cf53e53acbda41f7e5429838ee3a20c24

Authored by 黄 x
1 parent 7a982580

docs: 增加Swagger的APi说明

... ... @@ -4,6 +4,7 @@ package org.thingsboard.server.common.data.yunteng.dto;
4 4 import com.fasterxml.jackson.annotation.JsonFormat;
5 5 import com.fasterxml.jackson.annotation.JsonIgnore;
6 6 import com.fasterxml.jackson.annotation.JsonInclude;
  7 +import io.swagger.annotations.ApiModelProperty;
7 8 import lombok.Data;
8 9 import org.springframework.beans.BeanUtils;
9 10 import org.thingsboard.server.common.data.yunteng.common.UpdateGroup;
... ... @@ -20,16 +21,21 @@ import java.time.LocalDateTime;
20 21 @JsonInclude(JsonInclude.Include.NON_NULL)
21 22 public class BaseDTO {
22 23 @NotEmpty(message = "ID不能为空或者空字符串",groups = {UpdateGroup.class})
  24 + @ApiModelProperty(value = "ID")
23 25 private String id;
24 26 /**创建用户*/
  27 + @ApiModelProperty(value = "创建用户")
25 28 private String creator;
26 29 /**创建时间*/
27 30 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  31 + @ApiModelProperty(value = "创建时间")
28 32 private LocalDateTime createTime;
29 33 /**更新用户*/
  34 + @ApiModelProperty(value = "更新用户")
30 35 private String updater;
31 36 /**更新时间*/
32 37 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  38 + @ApiModelProperty(value = "更新时间")
33 39 private LocalDateTime updateTime;
34 40 @JsonIgnore
35 41 public <E> void copyToEntity(E entity, String... ignoreProperties) {
... ...
1 1 package org.thingsboard.server.common.data.yunteng.dto;
2 2
3   -import com.fasterxml.jackson.annotation.JsonFormat;
  3 +
4 4 import com.fasterxml.jackson.annotation.JsonIgnore;
5 5 import com.fasterxml.jackson.annotation.JsonInclude;
6 6 import com.fasterxml.jackson.databind.JsonNode;
  7 +import io.swagger.annotations.ApiModelProperty;
7 8 import lombok.Data;
8 9 import lombok.EqualsAndHashCode;
9 10 import org.thingsboard.server.common.data.yunteng.enums.MenuTypeEnum;
10   -
11   -import java.time.LocalDateTime;
12 11 import java.util.ArrayList;
13 12 import java.util.List;
14 13 import java.util.Objects;
... ... @@ -16,24 +15,26 @@ import java.util.Objects;
16 15 @EqualsAndHashCode(callSuper = true)
17 16 @Data
18 17 public class MenuDTO extends BaseDTO implements Comparable<MenuDTO> {
19   - private String id;
20   - /**
21   - * if menu type is system default, the menu name can be null; if menu type is not system default,
22   - * menu name is user defined
23   - */
  18 + @ApiModelProperty(value = "菜单名称", required = true)
24 19 private String name;
25   -
26   - // @JsonIgnore
  20 + @ApiModelProperty(value = "上级ID")
27 21 private String parentId;
  22 + @ApiModelProperty(value = "子节点")
28 23 private List<MenuDTO> children;
  24 + @ApiModelProperty(value = "路由地址", required = true)
29 25 private String path;
30   - // @JsonIgnore
31 26 private MenuTypeEnum type;
  27 + @ApiModelProperty(value = "权限标识")
32 28 private String permission;
  29 + @ApiModelProperty(value = "排序字段")
33 30 private Integer sort;
  31 + @ApiModelProperty(value = "租户ID")
34 32 @JsonIgnore private String tenantId;
  33 + @ApiModelProperty(value = "组件路径", required = true)
35 34 private String component;
  35 + @ApiModelProperty(value = "元数据")
36 36 private JsonNode meta;
  37 + @ApiModelProperty(value = "别名")
37 38 @JsonIgnore private String alias;
38 39
39 40 @JsonInclude(JsonInclude.Include.NON_NULL)
... ... @@ -42,12 +43,6 @@ public class MenuDTO extends BaseDTO implements Comparable<MenuDTO> {
42 43 @JsonInclude(JsonInclude.Include.NON_NULL)
43 44 private Boolean caseSensitive;
44 45
45   - @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
46   - private LocalDateTime createTime;
47   -
48   - @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
49   - private LocalDateTime updateTime;
50   -
51 46 public MenuDTO() {
52 47 this.children = new ArrayList<>();
53 48 }
... ...