WANG 6 жил өмнө
parent
commit
0c5372c2c5

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

@@ -8,19 +8,23 @@ import org.springframework.web.bind.annotation.RestController;
 
 import cn.com.qmth.examcloud.commons.web.support.ControllerSupport;
 import cn.com.qmth.examcloud.examwork.api.ExamStudentCloudService;
+import cn.com.qmth.examcloud.examwork.api.request.SaveExamStudentReq;
 import cn.com.qmth.examcloud.exchange.outer.api.ExamStudentOuterService;
 import cn.com.qmth.examcloud.exchange.outer.api.bean.ExamStudentBean;
-import cn.com.qmth.examcloud.exchange.outer.api.request.SaveExamStudentReq;
+import cn.com.qmth.examcloud.exchange.outer.api.request.OuterSaveExamStudentReq;
 import cn.com.qmth.examcloud.exchange.outer.api.response.SaveExamStudentResp;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 
 /**
- * 类注释
+ * 考生服务
  *
  * @author WANGWEI
  * @date 2018年7月2日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
+@Api("考生服务")
 @RestController
 @RequestMapping("${$rmp.cloud.exchange.outer}/examStudent")
 public class ExamStudentOuterServiceProvider extends ControllerSupport
@@ -32,11 +36,12 @@ public class ExamStudentOuterServiceProvider extends ControllerSupport
 	@Autowired
 	ExamStudentCloudService examStudentCloudService;
 
-	@ApiOperation(value = "保存考生信息")
+	@ApiOperation(value = "保存考生信息", response = String.class)
 	@PostMapping("saveExamStudent")
 	@Override
-	public SaveExamStudentResp saveExamStudent(@RequestBody SaveExamStudentReq req) {
-		cn.com.qmth.examcloud.examwork.api.request.SaveExamStudentReq request = new cn.com.qmth.examcloud.examwork.api.request.SaveExamStudentReq();
+	public SaveExamStudentResp saveExamStudent(
+			@RequestBody @ApiParam(name = "请求体", required = true) OuterSaveExamStudentReq req) {
+		SaveExamStudentReq request = new SaveExamStudentReq();
 
 		request.setCourseCode(req.getCourseCode());
 		request.setCourseLevel(req.getCourseLevel());

+ 2 - 2
examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/ExamStudentOuterService.java

@@ -1,7 +1,7 @@
 package cn.com.qmth.examcloud.exchange.outer.api;
 
 import cn.com.qmth.examcloud.commons.web.cloud.api.OuterService;
-import cn.com.qmth.examcloud.exchange.outer.api.request.SaveExamStudentReq;
+import cn.com.qmth.examcloud.exchange.outer.api.request.OuterSaveExamStudentReq;
 import cn.com.qmth.examcloud.exchange.outer.api.response.SaveExamStudentResp;
 
 /**
@@ -13,6 +13,6 @@ import cn.com.qmth.examcloud.exchange.outer.api.response.SaveExamStudentResp;
  */
 public interface ExamStudentOuterService extends OuterService {
 
-	SaveExamStudentResp saveExamStudent(SaveExamStudentReq req);
+	SaveExamStudentResp saveExamStudent(OuterSaveExamStudentReq req);
 
 }

+ 22 - 32
examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/SaveExamStudentReq.java → examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/OuterSaveExamStudentReq.java

@@ -1,59 +1,49 @@
 package cn.com.qmth.examcloud.exchange.outer.api.request;
 
 import cn.com.qmth.examcloud.commons.web.cloud.api.BaseRequest;
-
-public class SaveExamStudentReq extends BaseRequest {
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+/**
+ * 类注释
+ *
+ * @author WANGWEI
+ * @date 2018年11月14日
+ * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
+ */
+@ApiModel(value = "SaveExamStudentReq", description = "请求体")
+public class OuterSaveExamStudentReq extends BaseRequest {
 
 	private static final long serialVersionUID = -8455805881947392754L;
 
-	/**
-	 * 顶级机构ID
-	 */
+	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
 	private Long rootOrgId;
 
-	/**
-	 * 考试ID
-	 */
+	@ApiModelProperty(value = "考试ID", example = "100", required = false)
 	private Long examId;
 
-	/**
-	 * 考试名称
-	 */
+	@ApiModelProperty(value = "考试名称", example = "2018年秋季入学考试", required = true)
 	private String examName;
 
-	/**
-	 * 学生姓名
-	 */
+	@ApiModelProperty(value = "学生姓名", example = "陈圆圆", required = true)
 	private String studentName;
 
-	/**
-	 * 学生学号
-	 */
+	@ApiModelProperty(value = "学生学号", example = "2018001001", required = true)
 	private String studentCode;
 
-	/**
-	 * 学生身份证号
-	 */
+	@ApiModelProperty(value = "学生身份证号", example = "XXXXXXXXXXXXXXXXXX", required = true)
 	private String identityNumber;
 
-	/**
-	 * 考试课程名称
-	 */
+	@ApiModelProperty(value = "考试课程名称", example = "大学英语", required = true)
 	private String courseName;
 
-	/**
-	 * 考试课程code
-	 */
+	@ApiModelProperty(value = "考试课程code", example = "K2", required = true)
 	private String courseCode;
 
-	/**
-	 * 考试课程level
-	 */
+	@ApiModelProperty(value = "考试课程level.  ZSB:专升本;GQZ:高起专;GQB:高起本;ALL:不限", example = "ALL", required = true)
 	private String courseLevel;
 
-	/**
-	 * 试卷类型
-	 */
+	@ApiModelProperty(value = "试卷类型,大写字母A-Z", example = "X", required = true)
 	private String paperType;
 
 	public Long getRootOrgId() {