1.1.0 增加swagger接口说明

src/main/java/com/qmth/eds/api/BasicSchoolController.java

@@ -4,6 +4,7 @@ import com.qmth.boot.api.constant.ApiConstant;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.BasicSchoolService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -20,6 +21,7 @@ import javax.annotation.Resource;
  * @author wangliang
  * @since 2022-05-14
  */
+@Api(tags = "学校接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/basic_school")
 public class BasicSchoolController {

src/main/java/com/qmth/eds/api/CloudMarkingExamController.java

@@ -4,6 +4,7 @@ import com.qmth.boot.api.constant.ApiConstant;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.CloudMarkingExamService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -13,12 +14,10 @@ import javax.annotation.Resource;
 
 /**
  * <p>
- * 学校表 前端控制器
+ * 云阅卷考试 前端控制器
  * </p>
- *
- * @author wangliang
- * @since 2022-05-14
  */
+@Api(tags = "云阅卷考试接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/cloud_marking_exam")
 public class CloudMarkingExamController {

src/main/java/com/qmth/eds/api/CloudMarkingScoreController.java

@@ -7,6 +7,7 @@ import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.job.service.JobService;
 import com.qmth.eds.service.CloudMarkingScoreService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -19,12 +20,10 @@ import javax.validation.constraints.Min;
 
 /**
  * <p>
- * 学校表 前端控制器
+ * 云阅卷成绩 前端控制器
  * </p>
- *
- * @author wangliang
- * @since 2022-05-14
  */
+@Api(tags = "成绩接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/cloud_marking_score")
 public class CloudMarkingScoreController {

src/main/java/com/qmth/eds/api/CloudMarkingScoreForeignController.java

@@ -5,6 +5,7 @@ import com.qmth.eds.common.contant.SystemConstant;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.CloudMarkingScoreForeignService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -18,12 +19,10 @@ import javax.validation.constraints.Min;
 
 /**
  * <p>
- * 学校表 前端控制器
+ * 云阅卷考试 前端控制器
  * </p>
- *
- * @author wangliang
- * @since 2022-05-14
  */
+@Api(tags = "对外成绩接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/cloud_marking_score_foreign")
 public class CloudMarkingScoreForeignController {

src/main/java/com/qmth/eds/api/ExamAssignController.java

@@ -33,7 +33,7 @@ import java.util.Objects;
  * 赋分管理 前端控制器
  * </p>
  */
-@Api(tags = "赋分管理controller")
+@Api(tags = "赋分接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/assign")
 @Validated

src/main/java/com/qmth/eds/api/ExamCourseMappingController.java

@@ -5,6 +5,7 @@ import com.qmth.eds.common.contant.SystemConstant;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.ExamCourseMappingService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -16,6 +17,7 @@ import javax.annotation.Resource;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "云阅卷科目与教务数据科目对应关系接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_course_mapping")
 public class ExamCourseMappingController {

src/main/java/com/qmth/eds/api/ExamDownloadRecordController.java

@@ -6,6 +6,7 @@ import com.qmth.eds.common.enums.UseSceneEnum;
 import com.qmth.eds.service.ExamDownloadRecordService;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -16,6 +17,7 @@ import javax.annotation.Resource;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "下载记录接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_download_record")
 public class ExamDownloadRecordController {

src/main/java/com/qmth/eds/api/ExamScheduleTaskController.java

@@ -6,6 +6,7 @@ import com.qmth.eds.common.entity.ExamScheduleTask;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.ExamScheduleTaskService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
 import org.springframework.validation.BindingResult;
@@ -16,6 +17,7 @@ import javax.validation.Valid;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "任务管理接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_schedule_task")
 public class ExamScheduleTaskController {

src/main/java/com/qmth/eds/api/ExamSemesterController.java

@@ -6,6 +6,7 @@ import com.qmth.eds.common.entity.ExamSemester;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.ExamSemesterService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 
@@ -13,6 +14,7 @@ import javax.annotation.Resource;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "学期管理接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_semester")
 public class ExamSemesterController {

src/main/java/com/qmth/eds/api/ExamSyncTotalController.java

@@ -7,6 +7,7 @@ import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.job.service.JobService;
 import com.qmth.eds.service.ExamSyncTotalService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -18,6 +19,7 @@ import javax.servlet.http.HttpServletResponse;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "教务数据同步接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_sync_total")
 public class ExamSyncTotalController {

src/main/java/com/qmth/eds/api/ExamTypeController.java

@@ -6,6 +6,7 @@ import com.qmth.eds.common.entity.ExamType;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.ExamTypeService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 
@@ -13,6 +14,7 @@ import javax.annotation.Resource;
 import javax.validation.constraints.Max;
 import javax.validation.constraints.Min;
 
+@Api(tags = "考试类型接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/exam_type")
 public class ExamTypeController {

src/main/java/com/qmth/eds/api/SysCollegeController.java

@@ -5,6 +5,7 @@ import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.BasicSchoolService;
 import com.qmth.eds.service.SysCollegeService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -17,6 +18,7 @@ import javax.annotation.Resource;
  * 学院表 前端控制器
  * </p>
  */
+@Api(tags = "学院管理接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/sys_college")
 public class SysCollegeController {

src/main/java/com/qmth/eds/api/SysController.java

@@ -29,7 +29,7 @@ import java.util.*;
 /**
  * 系统公共Controller
  */
-@Api(tags = "系统Controller")
+@Api(tags = "系统接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/common")
 public class SysController {

src/main/java/com/qmth/eds/api/SysRoleController.java

@@ -5,6 +5,7 @@ import com.qmth.eds.common.enums.RoleTypeEnum;
 import com.qmth.eds.service.SysRoleService;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -20,6 +21,7 @@ import javax.annotation.Resource;
  * @author wangliang
  * @since 2022-05-14
  */
+@Api(tags = "角色接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/sys_role")
 public class SysRoleController {

src/main/java/com/qmth/eds/api/SysSettingController.java

@@ -22,7 +22,7 @@ import java.util.List;
  * 系统设置 前端控制器
  * </p>
  */
-@Api(tags = "系统设置controller")
+@Api(tags = "系统设置接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/sys_setting")
 @Validated

src/main/java/com/qmth/eds/api/SysUserController.java

@@ -6,6 +6,7 @@ import com.qmth.eds.common.entity.SysUser;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.SysUserService;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
 import org.springframework.validation.BindingResult;
@@ -24,6 +25,7 @@ import javax.validation.constraints.Min;
  * @author wangliang
  * @since 2022-05-14
  */
+@Api(tags = "用户接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/sys_user")
 public class SysUserController {

src/main/java/com/qmth/eds/api/TBSyncTaskController.java

@@ -11,10 +11,7 @@ import com.qmth.eds.common.enums.TaskTypeEnum;
 import com.qmth.eds.common.util.Result;
 import com.qmth.eds.common.util.ResultUtil;
 import com.qmth.eds.service.TBSyncTaskService;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
+import io.swagger.annotations.*;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
@@ -30,6 +27,7 @@ import javax.validation.constraints.Min;
  * </p>
  *
  */
+@Api(tags = "异步任务接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/sync_task")
 public class TBSyncTaskController {

src/main/java/com/qmth/eds/api/TSAuthController.java

@@ -31,7 +31,7 @@ import java.io.IOException;
  * @author wangliang
  * @since 2022-04-26
  */
-@Api(tags = "授权配置Controller")
+@Api(tags = "授权配置接口")
 @RestController
 @RequestMapping(ApiConstant.DEFAULT_URI_PREFIX + "/auth")
 @Validated