新增自动扫描@Table的列注释到Swagger在线文档,并补充字段说明。

This commit is contained in:
thinkgem
2023-02-27 09:59:45 +08:00
parent b6e9151be5
commit 0a95c15ff0
5 changed files with 32 additions and 21 deletions

View File

@@ -4,8 +4,6 @@
*/ */
package com.jeesite.modules.sys.entity; package com.jeesite.modules.sys.entity;
import javax.validation.Valid;
import com.jeesite.common.entity.BaseEntity; import com.jeesite.common.entity.BaseEntity;
import com.jeesite.common.entity.DataEntity; import com.jeesite.common.entity.DataEntity;
import com.jeesite.common.entity.TreeEntity; import com.jeesite.common.entity.TreeEntity;
@@ -19,6 +17,9 @@ import com.jeesite.common.utils.excel.annotation.ExcelField.Align;
import com.jeesite.common.utils.excel.annotation.ExcelFields; import com.jeesite.common.utils.excel.annotation.ExcelFields;
import com.jeesite.common.utils.excel.fieldtype.CompanyType; import com.jeesite.common.utils.excel.fieldtype.CompanyType;
import com.jeesite.common.utils.excel.fieldtype.OfficeType; import com.jeesite.common.utils.excel.fieldtype.OfficeType;
import io.swagger.annotations.ApiModelProperty;
import javax.validation.Valid;
/** /**
* 员工用户管理Entity * 员工用户管理Entity
@@ -123,7 +124,8 @@ public class EmpUser extends User {
public void setEmployee(Employee employee){ public void setEmployee(Employee employee){
super.setRefObj(employee); super.setRefObj(employee);
} }
@ApiModelProperty("根据各种编码查询")
public String[] getCodes() { public String[] getCodes() {
return codes; return codes;
} }

View File

@@ -4,12 +4,6 @@
*/ */
package com.jeesite.modules.sys.entity; package com.jeesite.modules.sys.entity;
import java.util.List;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import com.jeesite.common.collect.ListUtils; import com.jeesite.common.collect.ListUtils;
import com.jeesite.common.entity.BaseEntity; import com.jeesite.common.entity.BaseEntity;
import com.jeesite.common.entity.DataEntity; import com.jeesite.common.entity.DataEntity;
@@ -19,6 +13,11 @@ import com.jeesite.common.mybatis.annotation.JoinTable;
import com.jeesite.common.mybatis.annotation.JoinTable.Type; import com.jeesite.common.mybatis.annotation.JoinTable.Type;
import com.jeesite.common.mybatis.annotation.Table; import com.jeesite.common.mybatis.annotation.Table;
import com.jeesite.common.mybatis.mapper.query.QueryType; import com.jeesite.common.mybatis.mapper.query.QueryType;
import io.swagger.annotations.ApiModelProperty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.util.List;
/** /**
* 员工管理Entity * 员工管理Entity
@@ -130,6 +129,7 @@ public class Employee extends DataEntity<Employee> {
this.company = company; this.company = company;
} }
@ApiModelProperty("根据岗位编码查询")
public String getPostCode() { public String getPostCode() {
return postCode; return postCode;
} }
@@ -146,6 +146,7 @@ public class Employee extends DataEntity<Employee> {
this.employeePostList = employeePostList; this.employeePostList = employeePostList;
} }
@ApiModelProperty("员工岗位关系")
public String getEmployeePosts() { public String getEmployeePosts() {
List<String> list = ListUtils.extractToList(employeePostList, "postCode"); List<String> list = ListUtils.extractToList(employeePostList, "postCode");
return StringUtils.join(list, ","); return StringUtils.join(list, ",");

View File

@@ -14,6 +14,7 @@ import com.jeesite.common.lang.TimeUtils;
import com.jeesite.common.mybatis.annotation.Column; import com.jeesite.common.mybatis.annotation.Column;
import com.jeesite.common.mybatis.annotation.Table; import com.jeesite.common.mybatis.annotation.Table;
import com.jeesite.common.mybatis.mapper.query.QueryType; import com.jeesite.common.mybatis.mapper.query.QueryType;
import io.swagger.annotations.ApiModelProperty;
import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size; import javax.validation.constraints.Size;
@@ -228,7 +229,8 @@ public class Log extends DataEntity<Log> {
public void setExecuteTime(Long executeTime) { public void setExecuteTime(Long executeTime) {
this.executeTime = executeTime; this.executeTime = executeTime;
} }
@ApiModelProperty("格式化后的执行时间")
public String getExecuteTimeFormat(){ public String getExecuteTimeFormat(){
if (executeTime == null) { if (executeTime == null) {
executeTime = 0L; executeTime = 0L;

View File

@@ -4,10 +4,6 @@
*/ */
package com.jeesite.modules.sys.entity; package com.jeesite.modules.sys.entity;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonIgnore; import com.fasterxml.jackson.annotation.JsonIgnore;
import com.jeesite.common.entity.BaseEntity; import com.jeesite.common.entity.BaseEntity;
import com.jeesite.common.entity.DataEntity; import com.jeesite.common.entity.DataEntity;
@@ -20,6 +16,11 @@ import com.jeesite.common.utils.excel.annotation.ExcelField;
import com.jeesite.common.utils.excel.annotation.ExcelField.Align; import com.jeesite.common.utils.excel.annotation.ExcelField.Align;
import com.jeesite.common.utils.excel.annotation.ExcelFields; import com.jeesite.common.utils.excel.annotation.ExcelFields;
import com.jeesite.modules.sys.utils.EmpUtils; import com.jeesite.modules.sys.utils.EmpUtils;
import io.swagger.annotations.ApiModelProperty;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
/** /**
* 组织机构Entity * 组织机构Entity
@@ -137,7 +138,8 @@ public class Office extends TreeEntity<Office> {
public void setOfficeType(String officeType) { public void setOfficeType(String officeType) {
this.officeType = officeType; this.officeType = officeType;
} }
@ApiModelProperty("包含某机构类型")
public String[] getOfficeType_in(){ public String[] getOfficeType_in(){
return sqlMap.getWhere().getValue("office_type", QueryType.IN); return sqlMap.getWhere().getValue("office_type", QueryType.IN);
} }
@@ -198,7 +200,8 @@ public class Office extends TreeEntity<Office> {
public void setExtend(Extend extend) { public void setExtend(Extend extend) {
this.extend = extend; this.extend = extend;
} }
@ApiModelProperty("公司编码")
public String getCompanyCode() { public String getCompanyCode() {
return companyCode; return companyCode;
} }

View File

@@ -4,15 +4,16 @@
*/ */
package com.jeesite.modules.sys.entity; package com.jeesite.modules.sys.entity;
import javax.validation.constraints.Size;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import com.jeesite.common.entity.BaseEntity; import com.jeesite.common.entity.BaseEntity;
import com.jeesite.common.entity.DataEntity; import com.jeesite.common.entity.DataEntity;
import com.jeesite.common.mybatis.annotation.Column; import com.jeesite.common.mybatis.annotation.Column;
import com.jeesite.common.mybatis.annotation.Table; import com.jeesite.common.mybatis.annotation.Table;
import com.jeesite.common.mybatis.mapper.query.QueryType; import com.jeesite.common.mybatis.mapper.query.QueryType;
import io.swagger.annotations.ApiModelProperty;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
@Table(name="${_prefix}sys_post", alias="a", label="岗位信息", columns={ @Table(name="${_prefix}sys_post", alias="a", label="岗位信息", columns={
@Column(includeEntity=BaseEntity.class), @Column(includeEntity=BaseEntity.class),
@@ -70,7 +71,8 @@ public class Post extends DataEntity<Post> {
public void setPostName(String postName) { public void setPostName(String postName) {
this.postName = postName; this.postName = postName;
} }
@ApiModelProperty("模糊查询岗位名称")
public String getPostName_like() { public String getPostName_like() {
return sqlMap().getWhere().getValue("post_name", QueryType.LIKE); return sqlMap().getWhere().getValue("post_name", QueryType.LIKE);
} }
@@ -96,6 +98,7 @@ public class Post extends DataEntity<Post> {
this.postSort = postSort; this.postSort = postSort;
} }
@ApiModelProperty("根据员工编码查询")
public String getEmpCode() { public String getEmpCode() {
return empCode; return empCode;
} }