接口文档注释

stmms-biz/pom.xml

@@ -14,6 +14,10 @@
     <url>http://maven.apache.org</url>
 
     <dependencies>
+    <dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+		</dependency>
         <dependency>
             <groupId>cn.com.qmth.stmms</groupId>
             <artifactId>stmms-common</artifactId>

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/basic/bean/RoleInfoQuery.java

@@ -1,27 +1,29 @@
-package cn.com.qmth.stmms.biz.basic.bean;
-
-import cn.com.qmth.stmms.biz.common.BaseQuery;
-
-public class RoleInfoQuery extends BaseQuery<RoleInfoVo> {
-
-	private String role;
-
-	private Integer schoolId;
-
-	public String getRole() {
-		return role;
-	}
-
-	public void setRole(String role) {
-		this.role = role;
-	}
-
-	public Integer getSchoolId() {
-		return schoolId;
-	}
-
-	public void setSchoolId(Integer schoolId) {
-		this.schoolId = schoolId;
-	}
-
-}
+package cn.com.qmth.stmms.biz.basic.bean;
+
+import cn.com.qmth.stmms.biz.common.BaseQuery;
+import io.swagger.annotations.ApiModelProperty;
+
+public class RoleInfoQuery extends BaseQuery<RoleInfoVo> {
+
+    @ApiModelProperty(value = "角色code")
+    private String role;
+
+    private Integer schoolId;
+
+    public String getRole() {
+        return role;
+    }
+
+    public void setRole(String role) {
+        this.role = role;
+    }
+
+    public Integer getSchoolId() {
+        return schoolId;
+    }
+
+    public void setSchoolId(Integer schoolId) {
+        this.schoolId = schoolId;
+    }
+
+}

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/basic/bean/RolePrivilegeVo.java

@@ -1,33 +1,51 @@
-package cn.com.qmth.stmms.biz.basic.bean;
-
-public class RolePrivilegeVo {
-	private String name;
-	private String code;
-	private String parentCode;
-	private Boolean enable;
-	public String getName() {
-		return name;
-	}
-	public void setName(String name) {
-		this.name = name;
-	}
-	public String getCode() {
-		return code;
-	}
-	public void setCode(String code) {
-		this.code = code;
-	}
-	public String getParentCode() {
-		return parentCode;
-	}
-	public void setParentCode(String parentCode) {
-		this.parentCode = parentCode;
-	}
-	public Boolean getEnable() {
-		return enable;
-	}
-	public void setEnable(Boolean enable) {
-		this.enable = enable;
-	}
-	
-}
+package cn.com.qmth.stmms.biz.basic.bean;
+
+import io.swagger.annotations.ApiModelProperty;
+
+public class RolePrivilegeVo {
+
+    @ApiModelProperty(value = "权限名")
+    private String name;
+
+    @ApiModelProperty(value = "权限code")
+    private String code;
+
+    @ApiModelProperty(value = "权限树父code")
+    private String parentCode;
+
+    @ApiModelProperty(value = "是否勾选")
+    private Boolean enable;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public void setCode(String code) {
+        this.code = code;
+    }
+
+    public String getParentCode() {
+        return parentCode;
+    }
+
+    public void setParentCode(String parentCode) {
+        this.parentCode = parentCode;
+    }
+
+    public Boolean getEnable() {
+        return enable;
+    }
+
+    public void setEnable(Boolean enable) {
+        this.enable = enable;
+    }
+
+}

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/exam/bean/ExamReport.java

@@ -1,25 +1,37 @@
 package cn.com.qmth.stmms.biz.exam.bean;
 
+import io.swagger.annotations.ApiModelProperty;
+
 public class ExamReport {
 
+    @ApiModelProperty(value = "学校名")
     private String schoolName;
 
+    @ApiModelProperty(value = "年度")
     private Integer year;
 
+    @ApiModelProperty(value = "条码张数")
     private Long studentCount;
 
+    @ApiModelProperty(value = "科目数")
     private Long subjectCount;
 
+    @ApiModelProperty(value = "A3科次数")
     private Long subjectiveStudentCount;
 
+    @ApiModelProperty(value = "A4科次数")
     private Long objectiveStudentCount;
 
+    @ApiModelProperty(value = "A3答题卡张数")
     private Long subjectivePaperCount;
 
+    @ApiModelProperty(value = "A4答题卡张数")
     private Long objectivePaperCount;
 
+    @ApiModelProperty(value = "总科次数")
     private Long allUploadStudentCount;
 
+    @ApiModelProperty(value = "总答题卡张数")
     private Long totalPaperCount;
 
     public String getSchoolName() {

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/exam/bean/ExamView.java

@@ -1,15 +1,22 @@
 package cn.com.qmth.stmms.biz.exam.bean;
 
+import io.swagger.annotations.ApiModelProperty;
+
 public class ExamView {
 
+    @ApiModelProperty(value = "考生数")
     private Long studentCount;
 
+    @ApiModelProperty(value = "科目数")
     private Long subjectCount;
 
+    @ApiModelProperty(value = "扫描进度")
     private Long scanCount;
 
+    @ApiModelProperty(value = "扫描张数")
     private Long paperCount;
 
+    @ApiModelProperty(value = "评卷进度")
     private Long markedCount;
 
     public Long getStudentCount() {

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/exam/bean/ExamVo.java

@@ -9,6 +9,7 @@ import cn.com.qmth.stmms.common.enums.ExamType;
 import cn.com.qmth.stmms.common.enums.MarkMode;
 import cn.com.qmth.stmms.common.enums.ObjectiveStatus;
 import cn.com.qmth.stmms.common.enums.TrackCountPolicy;
+import io.swagger.annotations.ApiModelProperty;
 
 public class ExamVo {
 
@@ -16,26 +17,33 @@ public class ExamVo {
 
     private Integer id;
 
+    @ApiModelProperty(value = "名称")
     private String name;
 
     private Integer schoolId;
 
+    @ApiModelProperty(value = "code")
     private String code;
 
+    @ApiModelProperty(value = "考试时间")
     private Date examTime;
 
+    @ApiModelProperty(value = "状态")
     private ExamStatus status;
 
+    @ApiModelProperty(value = "描述")
     private String description;
 
     /**
      * 开启强制特殊标记
      */
+    @ApiModelProperty(value = "开启强制特殊标记")
     private Boolean forceSpecialTag;
 
     /**
      * 裁切图配置
      */
+    @ApiModelProperty(value = "裁切图配置")
     private String sliceConfig;
 
     private Date createTime;
@@ -47,112 +55,136 @@ public class ExamVo {
     /**
      * 统计配置
      */
+    @ApiModelProperty(value = "统计配置")
     private String sasConfig;
 
     /**
      * 原图遮盖配置
      */
+    @ApiModelProperty(value = "原图遮盖配置")
     private String sheetConfig;
 
     /**
      * 考试类型
      */
+    @ApiModelProperty(value = "考试类型")
     private ExamType type;
 
     /**
      * 题卡类型
      */
+    @ApiModelProperty(value = "题卡类型")
     private FormatType cardType;
 
     /**
      * 禁止管理员以外人查看考生个人信息
      */
+    @ApiModelProperty(value = "禁止管理员以外人查看考生个人信息")
     private Boolean forbiddenInfo;
 
     /**
      * 禁止查看成绩
      */
+    @ApiModelProperty(value = "禁止查看成绩")
     private Boolean forbiddenScore;
 
     /**
      * 客观题统分状态
      */
+    @ApiModelProperty(value = "客观题统分状态")
     private ObjectiveStatus objectiveStatus;
 
     /**
      * 评卷起始时间
      */
+    @ApiModelProperty(value = "评卷起始时间")
     private Date startTime;
 
     /**
      * 评卷结束时间
      */
+    @ApiModelProperty(value = "评卷结束时间")
     private Date endTime;
 
     /**
      * 强制评卷模式
      */
+    @ApiModelProperty(value = "强制评卷模式")
     private MarkMode markMode;
 
     /**
      * 开启/关闭 原卷显示
      */
+    @ApiModelProperty(value = "开启/关闭 原卷显示")
     private Boolean sheetView;
 
     /**
      * 扫描配置
      */
+    @ApiModelProperty(value = "扫描配置")
     private String scanConfig;
 
     /**
      * 自动跳转
      */
+    @ApiModelProperty(value = "自动跳转")
     private Boolean autoScroll;
 
     /**
      * 是否裁切
      */
+    @ApiModelProperty(value = "是否裁切")
     private Boolean enableSplit;
 
     /**
      * 打回后是否显示原分值
      */
+    @ApiModelProperty(value = "打回后是否显示原分值")
     private Boolean showReject;
 
     /**
      * 全卷多次复核时不能为同一账号
      */
+    @ApiModelProperty(value = "全卷多次复核时不能为同一账号")
     private Boolean inspectUnrepeated;
 
     /**
      * 全卷复核时强制试卷拉到底部
      */
+    @ApiModelProperty(value = "全卷复核时强制试卷拉到底部")
     private Boolean inspectScrollBottom;
 
     /**
      * 回评卷数
      */
+    @ApiModelProperty(value = "回评卷数")
     private Integer remarkCount;
 
     /**
      * 评卷端是否显示客观分
      */
+    @ApiModelProperty(value = "评卷端是否显示客观分")
     private Boolean showObjectiveScore;
 
     /**
      * 全卷复核进度100%时才能再次复核
      */
+    @ApiModelProperty(value = "全卷复核进度100%时才能再次复核")
     private Boolean inspectRoundLimit;
 
     /**
      * 轨迹次数规则
      */
+    @ApiModelProperty(value = "轨迹次数规则")
     private TrackCountPolicy trackCountPolicy;
 
+    @ApiModelProperty(value = "sheetConfig")
     private String pictureConfig;
 
+    @ApiModelProperty(value = "及格分")
     private Double passScore;
 
+    @ApiModelProperty(value = "优秀分")
     private Double excellentScore;
 
     public Integer getId() {

stmms-biz/src/main/java/cn/com/qmth/stmms/biz/exam/query/ExamSearchQuery.java

@@ -1,75 +1,82 @@
-package cn.com.qmth.stmms.biz.exam.query;
-
-import cn.com.qmth.stmms.biz.common.BaseQuery;
-import cn.com.qmth.stmms.biz.exam.model.Exam;
-import cn.com.qmth.stmms.common.enums.ExamStatus;
-import cn.com.qmth.stmms.common.enums.ExamType;
-import org.springframework.data.domain.Sort;
-import org.springframework.data.domain.Sort.Direction;
-
-public class ExamSearchQuery extends BaseQuery<Exam> {
-
-    private Integer id;
-
-    private String name;
-
-    private String code;
-
-    private Integer schoolId;
-
-    private ExamStatus status;
-
-    private ExamType type;
-
-    public void orderByIdDesc() {
-        setSort(new Sort(Direction.DESC, "id"));
-    }
-
-    public Integer getId() {
-        return id;
-    }
-
-    public void setId(Integer id) {
-        this.id = id;
-    }
-
-    public String getName() {
-        return name;
-    }
-
-    public void setName(String name) {
-        this.name = name;
-    }
-
-    public Integer getSchoolId() {
-        return schoolId;
-    }
-
-    public void setSchoolId(Integer schoolId) {
-        this.schoolId = schoolId;
-    }
-
-    public String getCode() {
-        return code;
-    }
-
-    public void setCode(String code) {
-        this.code = code;
-    }
-
-    public ExamStatus getStatus() {
-        return status;
-    }
-
-    public void setStatus(ExamStatus status) {
-        this.status = status;
-    }
-
-    public ExamType getType() {
-        return type;
-    }
-
-    public void setType(ExamType type) {
-        this.type = type;
-    }
-}
+package cn.com.qmth.stmms.biz.exam.query;
+
+import cn.com.qmth.stmms.biz.common.BaseQuery;
+import cn.com.qmth.stmms.biz.exam.model.Exam;
+import cn.com.qmth.stmms.common.enums.ExamStatus;
+import cn.com.qmth.stmms.common.enums.ExamType;
+import io.swagger.annotations.ApiModelProperty;
+
+import org.springframework.data.domain.Sort;
+import org.springframework.data.domain.Sort.Direction;
+
+public class ExamSearchQuery extends BaseQuery<Exam> {
+
+    @ApiModelProperty(value = "id")
+    private Integer id;
+
+    @ApiModelProperty(value = "名称")
+    private String name;
+
+    @ApiModelProperty(value = "code")
+    private String code;
+
+    private Integer schoolId;
+
+    @ApiModelProperty(value = "状态")
+    private ExamStatus status;
+
+    @ApiModelProperty(value = "类型")
+    private ExamType type;
+
+    public void orderByIdDesc() {
+        setSort(new Sort(Direction.DESC, "id"));
+    }
+
+    public Integer getId() {
+        return id;
+    }
+
+    public void setId(Integer id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Integer getSchoolId() {
+        return schoolId;
+    }
+
+    public void setSchoolId(Integer schoolId) {
+        this.schoolId = schoolId;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public void setCode(String code) {
+        this.code = code;
+    }
+
+    public ExamStatus getStatus() {
+        return status;
+    }
+
+    public void setStatus(ExamStatus status) {
+        this.status = status;
+    }
+
+    public ExamType getType() {
+        return type;
+    }
+
+    public void setType(ExamType type) {
+        this.type = type;
+    }
+}

stmms-web/src/main/java/cn/com/qmth/stmms/admin/config/SwaggerConfig.java

@@ -27,7 +27,7 @@ public class SwaggerConfig extends WebMvcConfigurationSupport {
 
     @Bean
     private ApiInfo apiInfo() {
-        return new ApiInfoBuilder().title("RESTful APIs").build();
+        return new ApiInfoBuilder().title("stmms api").build();
     }
 
     @Override

stmms-web/src/main/java/cn/com/qmth/stmms/api/controller/admin/ExamController.java

@@ -39,10 +39,13 @@ import cn.com.qmth.stmms.common.enums.ExamType;
 import cn.com.qmth.stmms.common.enums.LogType;
 import cn.com.qmth.stmms.common.enums.ObjectiveStatus;
 import cn.com.qmth.stmms.common.enums.TrackCountPolicy;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import net.sf.json.JSONArray;
 import net.sf.json.JSONObject;
 import net.sf.json.JsonConfig;
 
+@Api(tags = "考试管理")
 @Controller("adminExamController")
 @RequestMapping("/api/admin/exam")
 public class ExamController extends BaseApiController {
@@ -84,6 +87,7 @@ public class ExamController extends BaseApiController {
     // return exam;
     // }
 
+    @ApiOperation(value = "考试分页查询")
     @RequestMapping(value = "list", method = RequestMethod.POST)
     @ResponseBody
     public PageResult<Exam> list(ExamSearchQuery query) {
@@ -94,18 +98,21 @@ public class ExamController extends BaseApiController {
         return PageUtil.of(query);
     }
 
+    @ApiOperation(value = "考试类型")
     @RequestMapping(value = "types", method = RequestMethod.POST)
     @ResponseBody
     public List<ExamType> examTypeList() {
         return Arrays.asList(ExamType.values());
     }
 
+    @ApiOperation(value = "考试状态")
     @RequestMapping(value = "status", method = RequestMethod.POST)
     @ResponseBody
     public List<ExamStatus> statusLlist() {
         return Arrays.asList(ExamStatus.values());
     }
 
+    @ApiOperation(value = "考试信息查询")
     @ResponseBody
     @RequestMapping(value = "find", method = RequestMethod.POST)
     public ExamVo find(@RequestParam Integer examId) {
@@ -113,6 +120,7 @@ public class ExamController extends BaseApiController {
         return ExamVo.of(exam);
     }
 
+    @ApiOperation(value = "考试创建")
     @ResponseBody
     @Logging(menu = "创建考试", type = LogType.ADD)
     @RequestMapping(value = "save", method = RequestMethod.POST)
@@ -134,6 +142,7 @@ public class ExamController extends BaseApiController {
         exam = examService.save(exam);
     }
 
+    @ApiOperation(value = "考试编辑")
     @ResponseBody
     @Logging(menu = "编辑考试", type = LogType.UPDATE)
     @SuppressWarnings("unchecked")
@@ -180,6 +189,7 @@ public class ExamController extends BaseApiController {
         }
     }
 
+    @ApiOperation(value = "考试详情")
     @ResponseBody
     @Logging(menu = "考试详情", type = LogType.QUERY)
     @RequestMapping(value = "detail", method = RequestMethod.POST)
@@ -208,6 +218,7 @@ public class ExamController extends BaseApiController {
         return ret;
     }
 
+    @ApiOperation(value = "验收报告")
     @ResponseBody
     @RequestMapping(value = "report", method = RequestMethod.POST)
     public ExamReport report(@RequestParam Integer examId) {

stmms-web/src/main/java/cn/com/qmth/stmms/api/controller/admin/RoleController.java

@@ -60,12 +60,14 @@ public class RoleController extends BaseApiController {
         }
     }
 
+    @ApiOperation(value = "角色下拉列表")
     @ResponseBody
     @RequestMapping(value = "list/all", method = RequestMethod.POST)
     public List<RoleInfoVo> getAll(@RequestParam Integer schoolId) {
         return roleInfoService.allList(schoolId);
     }
 
+    @ApiOperation(value = "当前用户权限code集合")
     @ResponseBody
     @RequestMapping(value = "privilege/codes", method = RequestMethod.POST)
     public Set<String> privilegeCodes() {
@@ -73,6 +75,7 @@ public class RoleController extends BaseApiController {
         return rolePrivilegeService.getRoleCodes(wu.getUser().getSchoolId(), wu.getRole());
     }
 
+    @ApiOperation(value = "查询角色权限树")
     @ResponseBody
     @RequestMapping(value = "privilege/all", method = RequestMethod.POST)
     public List<RolePrivilegeVo> privilegeAll(RoleInfoQuery query) {
@@ -85,6 +88,7 @@ public class RoleController extends BaseApiController {
         return rolePrivilegeService.findByQuery(query);
     }
 
+    @ApiOperation(value = "当前用户左侧菜单树")
     @ResponseBody
     @RequestMapping(value = "privilege/menu", method = RequestMethod.POST)
     public List<Privilege> privilegeMenu() {
@@ -100,6 +104,7 @@ public class RoleController extends BaseApiController {
         return ret;
     }
 
+    @ApiOperation(value = "保存权限")
     @ResponseBody
     @RequestMapping(value = "privilege/save", method = RequestMethod.POST)
     public void privilegeSave(RolePrivilegeDomain domain) {