WANG hace 6 años
padre
commit
add925abba

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

@@ -18,6 +18,7 @@ import com.google.common.collect.Lists;
 import cn.com.qmth.examcloud.commons.base.exception.StatusException;
 import cn.com.qmth.examcloud.commons.base.util.HttpClientUtil;
 import cn.com.qmth.examcloud.commons.web.support.ControllerSupport;
+import cn.com.qmth.examcloud.commons.web.support.StatusResponse;
 import cn.com.qmth.examcloud.core.basic.api.StudentCloudService;
 import cn.com.qmth.examcloud.core.basic.api.request.SaveStudentReq;
 import cn.com.qmth.examcloud.core.basic.api.response.SaveStudentResp;
@@ -36,6 +37,9 @@ import cn.com.qmth.examcloud.exchange.outer.service.FaceService;
 import cn.com.qmth.examcloud.exchange.outer.service.bean.Course;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
 
 /**
  * 中国地质大学(武汉)
@@ -70,10 +74,14 @@ public class CugOuterServiceProvider extends ControllerSupport implements CugOut
 	private String tempDir;
 
 	@ApiOperation(value = "地址大学考生接入", httpMethod = "POST")
+	@ApiResponses({
+			@ApiResponse(code = 200, message = "成功", response = SaveCugStudentAndExamStudentResp.class),
+			@ApiResponse(code = 500, message = "系统异常(异常信息见响应体)", response = StatusResponse.class)})
 	@PostMapping("saveCugStudentAndExamStudent")
 	@Override
 	public SaveCugStudentAndExamStudentResp saveCugStudentAndExamStudent(
-			@RequestBody SaveCugStudentAndExamStudentReq req) {
+			@RequestBody @ApiParam(name = "请求体", value = "request body", required = true) SaveCugStudentAndExamStudentReq req) {
+
 		trim(req);
 
 		Long rootOrgId = req.getRootOrgId();

+ 15 - 33
examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/cug/SaveCugStudentAndExamStudentReq.java

@@ -1,70 +1,52 @@
 package cn.com.qmth.examcloud.exchange.outer.api.request.cug;
 
 import cn.com.qmth.examcloud.commons.web.cloud.api.BaseRequest;
+import io.swagger.annotations.ApiModelProperty;
 
 public class SaveCugStudentAndExamStudentReq extends BaseRequest {
 
 	private static final long serialVersionUID = 8293200048902081959L;
 
-	/**
-	 * 学生姓名
-	 */
+	@ApiModelProperty(value = "学生姓名", example = "陈圆圆", required = true)
 	private String name;
 
-	/**
-	 * 顶级机构ID
-	 */
+	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
 	private Long rootOrgId;
 
-	/**
-	 * 学习中心编码
-	 */
+	@ApiModelProperty(value = "学习中心编码", example = "LC111", required = true)
 	private String orgCode;
 
-	/**
-	 * 学习中心名称
-	 */
+	@ApiModelProperty(value = "学习中心名称", example = "XXX", required = true)
 	private String orgName;
 
-	/**
-	 * 学生code
-	 */
+	@ApiModelProperty(value = "学生学号", example = "2018001001", required = true)
 	private String studentCode;
 
-	/**
-	 * 身份证号码
-	 */
+	@ApiModelProperty(value = "学生身份证号", example = "XXXXXXXXXXXXXXXXXX", required = true)
 	private String identityNumber;
 
-	/**
-	 * 备注
-	 */
+	@ApiModelProperty(value = "备注", example = "XX", required = false)
 	private String remark;
 
-	/**
-	 * 图片地址
-	 */
+	@ApiModelProperty(value = "照片URL", example = "http://xxxx.xx/123.jpg", required = false)
 	private String photoUrl;
 
-	/**
-	 * 手机号码
-	 */
+	@ApiModelProperty(value = "手机号码", example = "XXXXXXXXXXX", required = true)
 	private String phoneNumber;
 
-	/**
-	 * 操作者
-	 */
+	@ApiModelProperty(value = "操作者", example = "XX系统", required = true)
 	private String operator;
 
+	@ApiModelProperty(value = "考试名称", example = "2018年秋季入学考试", required = true)
 	private String examName;
 
+	@ApiModelProperty(value = "专业名称", example = "计算机", required = false)
 	private String specialtyName;
 
+	@ApiModelProperty(value = "课程组", example = "本科", required = true)
 	private String courseGroupName;
 
-	/**
-	 * 试卷类型
-	 */
+	@ApiModelProperty(value = "试卷类型,大写字母A-Z", example = "X", required = true)
 	private String paperType;
 
 	public String getName() {

+ 0 - 2
examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/OuterSaveExamStudentResp.java

@@ -2,7 +2,6 @@ package cn.com.qmth.examcloud.exchange.outer.api.response;
 
 import cn.com.qmth.examcloud.commons.web.cloud.api.BaseResponse;
 import cn.com.qmth.examcloud.exchange.outer.api.bean.OuterExamStudentBean;
-import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 
 /**
@@ -12,7 +11,6 @@ import io.swagger.annotations.ApiModelProperty;
  * @date 2018年11月14日
  * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
  */
-@ApiModel(value = "json", description = "响应体")
 public class OuterSaveExamStudentResp extends BaseResponse {
 
 	private static final long serialVersionUID = 5003024673163742249L;

+ 14 - 1
examcloud-exchange-outer-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/cug/SaveCugStudentAndExamStudentResp.java

@@ -3,19 +3,32 @@ package cn.com.qmth.examcloud.exchange.outer.api.response.cug;
 import java.util.List;
 
 import cn.com.qmth.examcloud.commons.web.cloud.api.BaseResponse;
-
+import io.swagger.annotations.ApiModelProperty;
+
+/**
+ * 类注释
+ *
+ * @author WANGWEI
+ * @date 2018年11月15日
+ * @Copyright (c) 2018-? http://qmth.com.cn All Rights Reserved.
+ */
 public class SaveCugStudentAndExamStudentResp extends BaseResponse {
 
 	private static final long serialVersionUID = -7321764983963904493L;
 
+	@ApiModelProperty(value = "学生ID", example = "500", required = true)
 	private Long studentId;
 
+	@ApiModelProperty(value = "顶级机构ID", example = "0", required = true)
 	private Long rootOrgId;
 
+	@ApiModelProperty(value = "学习中心ID", example = "0", required = true)
 	private Long orgId;
 
+	@ApiModelProperty(value = "学习中心名称", example = "0", required = true)
 	private String orgName;
 
+	@ApiModelProperty(value = "考生ID集合", required = true)
 	private List<Long> examStudentIdList;
 
 	public Long getStudentId() {