Browse Source

update api param desc...

deason 8 months ago
parent
commit
ba84887bff

+ 3 - 3
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获取成绩数据", hidden = true)
     @PostMapping("/getScoreData")
     @Override
     public OuterGetScoreDataResp getScoreData(@RequestBody OuterGetScoreDataReq req) {
@@ -76,7 +76,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
         return outerGetScoreDataResp;
     }
 
-    @ApiOperation(value = "按某个考生获取成绩数据")
+    @ApiOperation(value = "按某个考生获取成绩数据", notes = "若该考生存在考多次情况,会对应有多条成绩记录")
     @PostMapping("/queryScoreData")
     @Override
     public OuterQueryScoreDataResp queryScoreData(@RequestBody OuterQueryScoreDataReq req) {
@@ -136,7 +136,7 @@ public class GetScoreDataServiceProvider extends ControllerSupport implements Ge
         return outerQueryScoreDataResp;
     }
 
-    @ApiOperation(value = "按考试获取成绩数据列表(分页)")
+    @ApiOperation(value = "按考试获取成绩数据列表(分页)", notes = "若某个考生存在考多次情况,会对应有多条成绩记录")
     @PostMapping("/queryScoreList")
     public OuterQueryScoreListResp queryScoreList(@RequestBody OuterQueryScoreListReq req) {
         if (req.getRootOrgId() == null) {

+ 1 - 1
examcloud-exchange-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/StudentOuterServiceProvider.java

@@ -115,7 +115,7 @@ public class StudentOuterServiceProvider extends ControllerSupport implements St
         if (StringUtils.isNotBlank(photoUrl)) {
             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);

+ 1 - 1
examcloud-exchange-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/cug/CugOuterServiceProvider.java

@@ -104,7 +104,7 @@ public class CugOuterServiceProvider extends ControllerSupport implements CugOut
         if (StringUtils.isNotBlank(photoUrl)) {
             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);