update api param desc...

examcloud-exchange-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/FaceOuterServiceProvider.java

@@ -60,10 +60,10 @@ public class FaceOuterServiceProvider extends ControllerSupport implements Enter
     @ApiOperation(value = "保存学生照片（图片URL）")
     @PostMapping("addPhotoByUrl")
     public void addPhotoByUrl(
-            @RequestParam @ApiParam(value = "顶级机构ID", example = "1", required = true) Long rootOrgId,
-            @RequestParam @ApiParam(value = "身份证", required = true) String identityNumber,
-            @RequestParam @ApiParam(value = "照片地址", required = true) String photoUrl,
-            @RequestParam @ApiParam(value = "操作者", required = true) String operator) {
+            @RequestParam @ApiParam(value = "顶级机构ID", example = "123", required = true) Long rootOrgId,
+            @RequestParam @ApiParam(value = "学生证件号", required = true) String identityNumber,
+            @RequestParam @ApiParam(value = "操作者", required = true) String operator,
+            @RequestParam @ApiParam(value = "学生照片URL", example = "http://xxx.xxx/xxx.jpg", required = true) String photoUrl) {
 
         if (!getEnterpriseRootOrgId().equals(rootOrgId)) {
             throw new StatusException("1000001", "rootOrgId is wrong");
@@ -72,7 +72,7 @@ public class FaceOuterServiceProvider extends ControllerSupport implements Enter
         if (photoUrl.startsWith("http")) {
             int lastIndexOf = photoUrl.lastIndexOf(".");
             if (0 > lastIndexOf) {
-                throw new StatusException("100002", "photoPath is not end with photo file suffix.");
+                throw new StatusException("100002", "参数photoUrl的值需要包含图片后缀名，如../xxx.jpg");
             }
 
             String fileSuffix = photoUrl.substring(lastIndexOf);
@@ -91,16 +91,15 @@ public class FaceOuterServiceProvider extends ControllerSupport implements Enter
 
             faceService.processFace(rootOrgId, identityNumber, fileSuffix, temp, operator);
         }
-
     }
 
     @ApiOperation(value = "保存学生照片（图片文件）")
     @PostMapping("addPhoto")
     public void addPhoto(
-            @RequestParam @ApiParam(value = "顶级机构ID", example = "1", required = true) Long rootOrgId,
-            @RequestParam @ApiParam(value = "身份证", required = true) String identityNumber,
+            @RequestParam @ApiParam(value = "顶级机构ID", example = "123", required = true) Long rootOrgId,
+            @RequestParam @ApiParam(value = "学生证件号", required = true) String identityNumber,
             @RequestParam @ApiParam(value = "操作者", required = true) String operator,
-            @RequestParam @ApiParam(value = "学生照片文件(文件名称=身份证号码+文件后缀) 如：xxxxxxxxxx.jpg", required = true) CommonsMultipartFile file) {
+            @RequestParam @ApiParam(value = "学生照片文件（文件名称=证件号+图片后缀）", required = true) CommonsMultipartFile file) {
 
         if (!getEnterpriseRootOrgId().equals(rootOrgId)) {
             throw new StatusException("1000001", "rootOrgId is wrong");
@@ -131,9 +130,9 @@ public class FaceOuterServiceProvider extends ControllerSupport implements Enter
     @ApiOperation(value = "保存学生照片（批量图片文件）")
     @PostMapping("importPhotos")
     public List<Map<String, String>> importPhotos(
-            @RequestParam @ApiParam(value = "顶级机构ID", example = "1", required = true) Long rootOrgId,
+            @RequestParam @ApiParam(value = "顶级机构ID", example = "123", required = true) Long rootOrgId,
             @RequestParam @ApiParam(value = "操作者", required = true) String operator,
-            @RequestParam @ApiParam(value = "学生照片文件(身份证号码+文件后缀)压缩包(ZIP文件,压缩包内不含目录)", required = true) CommonsMultipartFile file) {
+            @RequestParam @ApiParam(value = "学生照片压缩包zip文件，注意压缩包内不要建文件夹（文件名称=证件号+图片后缀）", required = true) CommonsMultipartFile file) {
 
         if (!getEnterpriseRootOrgId().equals(rootOrgId)) {
             throw new StatusException("1000001", "rootOrgId is wrong");

examcloud-exchange-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/GetScoreDataServiceProvider.java

@@ -40,7 +40,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
     @Autowired
     private ExamScoreDataCloudService examScoreDataCloudService;
 
-    @ApiOperation(value = "获取成绩数据（考试记录ID）")
+    @ApiOperation(value = "按某个考试记录ID获取成绩数据")
     @PostMapping("/getScoreData")
     @Override
     public OuterGetScoreDataResp getScoreData(@RequestBody OuterGetScoreDataReq req) {
@@ -53,6 +53,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
         if (req.getExamRecordDataId() == null) {
             throw new StatusException("1000003", "examRecordDataId不能为空");
         }
+
         GetScoreDataReq getScoreDataReq = new GetScoreDataReq();
         getScoreDataReq.setExamRecordDataId(req.getExamRecordDataId());
         GetScoreDataResp scoreDataResp = examScoreDataCloudService.getScoreData(getScoreDataReq);
@@ -75,7 +76,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
         return outerGetScoreDataResp;
     }
 
-    @ApiOperation(value = "获取成绩数据（考试名称、rootOrgId、courseCode、身份证号或学号）")
+    @ApiOperation(value = "按某个考生获取成绩数据")
     @PostMapping("/queryScoreData")
     @Override
     public OuterQueryScoreDataResp queryScoreData(@RequestBody OuterQueryScoreDataReq req) {
@@ -91,6 +92,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
         if (StringUtils.isBlank(req.getIdentityNumber()) && StringUtils.isBlank(req.getStudentCode())) {
             throw new StatusException("1000006", "身份证号和学号不能都为空");
         }
+
         QueryScoreDataReq queryScoreDataReq = new QueryScoreDataReq();
         queryScoreDataReq.setCourseCode(req.getCourseCode());
 
@@ -128,12 +130,13 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
             outerScoreDataBean.setTotalScore(scoreDataBean.getTotalScore());
             outerScoreDataBeanList.add(outerScoreDataBean);
         }
+
         OuterQueryScoreDataResp outerQueryScoreDataResp = new OuterQueryScoreDataResp();
         outerQueryScoreDataResp.setOuterScoreDataBeanList(outerScoreDataBeanList);
         return outerQueryScoreDataResp;
     }
 
-    @ApiOperation(value = "获取成绩数据列表（分页）")
+    @ApiOperation(value = "按考试获取成绩数据列表（分页）")
     @PostMapping("/queryScoreList")
     public OuterQueryScoreListResp queryScoreList(@RequestBody OuterQueryScoreListReq req) {
         if (req.getRootOrgId() == null) {

examcloud-exchange-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/ScoreQueueServiceProvider.java

@@ -36,7 +36,7 @@ public class ScoreQueueServiceProvider extends ControllerSupport implements Scor
     @Autowired
     private ExamCloudService examCloudService;
 
-    @ApiOperation(value = "取队列最顶层记录")
+    @ApiOperation(value = "_获取成绩队列首条记录", hidden = true)
     @PostMapping("/getScoreQueueTop")
     @Override
     public OuterGetScoreQueueTopResp getScoreQueueTop(@RequestBody OuterGetScoreQueueTopReq req) {
@@ -73,7 +73,7 @@ public class ScoreQueueServiceProvider extends ControllerSupport implements Scor
         return resp;
     }
 
-    @ApiOperation(value = "删除队列最顶层记录")
+    @ApiOperation(value = "_删除成绩队列某条记录", hidden = true)
     @PostMapping("/deleteScoreQueueTop")
     @Override
     public OuterDeleteScoreQueueTopResp deleteScoreQueueTop(@RequestBody OuterDeleteScoreQueueTopReq req) {