Browse Source

update doc

deason 5 years ago
parent
commit
7faa898374
11 changed files with 12 additions and 12 deletions
  1. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/CourseGroupOuterServiceProvider.java
  2. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/ExamOuterServiceProvider.java
  3. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/ExamQuestionOuterServiceProvider.java
  4. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/ExamStudentOuterServiceProvider.java
  5. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/FaceOuterServiceProvider.java
  6. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/GetExamRecordAuditInfoServiceProvider.java
  7. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/GetScoreDataServiceProvider.java
  8. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/QueryCapturePhotoServiceProvider.java
  9. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/ScoreQueueServiceProvider.java
  10. 1 1
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/StudentOuterServiceProvider.java
  11. 2 2
      examcloud-exchange-outer-api-provider/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/provider/cug/CugOuterServiceProvider.java

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

@@ -32,7 +32,7 @@ import io.swagger.annotations.ApiResponses;
  * @date 2019年1月7日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api(value = "课程组服务")
+@Api(tags = "课程相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/courseGroup")
 public class CourseGroupOuterServiceProvider extends ControllerSupport

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

@@ -38,7 +38,7 @@ import io.swagger.annotations.ApiResponses;
  * @date 2018年7月2日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api(value = "考试服务")
+@Api(tags = "考试相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/exam")
 public class ExamOuterServiceProvider extends ControllerSupport implements ExamOuterService {

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

@@ -59,7 +59,7 @@ import java.util.regex.Pattern;
  * @Date 2020/3/30 14:48
  * @Version 1.0
  */
-@Api("考试作答服务")
+@Api(tags = "考试作答相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/question")
 public class ExamQuestionOuterServiceProvider extends ControllerSupport implements ExamQuestionOuterService {

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

@@ -53,7 +53,7 @@ import io.swagger.annotations.ApiResponses;
  * @date 2018年7月2日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api(value = "考生服务")
+@Api(tags = "考生相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/examStudent")
 public class ExamStudentOuterServiceProvider extends ControllerSupport

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

@@ -36,7 +36,7 @@ import io.swagger.annotations.ApiParam;
  * @date 2018年11月14日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api("人脸服务")
+@Api(tags = "学生照片相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/face")
 public class FaceOuterServiceProvider extends ControllerSupport implements FaceOuterService {

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

@@ -21,7 +21,7 @@ import cn.com.qmth.examcloud.exchange.outer.api.response.OuterGetExamRecordAudit
 import cn.com.qmth.examcloud.web.support.ControllerSupport;
 import cn.com.qmth.examcloud.web.support.StatusResponse;
 
-@Api("获取考试记录审核信息服务")
+@Api(tags = "考试记录审核相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/examRecordAuditInfo")
 public class GetExamRecordAuditInfoServiceProvider  extends ControllerSupport implements GetExamRecordAuditInfoService{

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

@@ -33,7 +33,7 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.ArrayList;
 import java.util.List;
 
-@Api("获取成绩服务")
+@Api(tags = "考生成绩相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/score")
 public class GetScoreDataServiceProvider extends ControllerSupport implements GetScoreDataService {

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

@@ -26,7 +26,7 @@ import cn.com.qmth.examcloud.exchange.outer.api.response.OuterQueryCapturePhotoR
 import cn.com.qmth.examcloud.web.support.ControllerSupport;
 import cn.com.qmth.examcloud.web.support.StatusResponse;
 
-@Api("获取抓拍照片信息服务")
+@Api(tags = "考生抓拍照片相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/capturePhoto")
 public class QueryCapturePhotoServiceProvider extends ControllerSupport implements QueryCapturePhotoService {

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

@@ -28,7 +28,7 @@ import cn.com.qmth.examcloud.exchange.outer.api.response.OuterGetScoreQueueTopRe
 import cn.com.qmth.examcloud.web.support.ControllerSupport;
 import cn.com.qmth.examcloud.web.support.StatusResponse;
 
-@Api("成绩队列服务")
+@Api(tags = "考生成绩相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/scoreQueue")
 public class ScoreQueueServiceProvider extends ControllerSupport implements ScoreQueueService {

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

@@ -49,7 +49,7 @@ import io.swagger.annotations.ApiResponses;
  * @date 2018年6月29日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api(value = "学生服务")
+@Api(tags = "学生相关接口")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/student")
 public class StudentOuterServiceProvider extends ControllerSupport implements StudentOuterService {

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

@@ -48,7 +48,7 @@ import io.swagger.annotations.ApiResponses;
  * @date 2018年9月4日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@Api("废弃接口")
+@Api(tags = "考生相关接口")
 @RestController
 @RequestMapping("/api/ecs_outlet/cug")
 public class CugOuterServiceProvider extends ControllerSupport implements CugOuterService {
@@ -73,7 +73,7 @@ public class CugOuterServiceProvider extends ControllerSupport implements CugOut
 	@Autowired
 	SystemProperties systemConfig;
 
-	@ApiOperation(value = "废弃接口,考生接入", httpMethod = "POST")
+	@ApiOperation(value = "考生接入(已废弃)", httpMethod = "POST")
 	@ApiResponses({
 			@ApiResponse(code = 200, message = "成功", response = SaveCugStudentAndExamStudentResp.class),
 			@ApiResponse(code = 500, message = "系统异常(异常信息见响应体)", response = StatusResponse.class)})