5.0

sop-support/sop-service-support/src/main/java/com/gitee/sop/support/annotation/Open.java

@@ -27,7 +27,7 @@ public @interface Open {
     String version() default "1.0";
 
     /**
-     * 指定接口是否需要授权才能访问，可在admin中进行修改
+     * 指定接口是否需要授权才能访问，可在admin中进行授权
      */
     boolean permission() default false;
 
@@ -36,4 +36,27 @@ public @interface Open {
      */
     boolean needToken() default false;
 
+    /**
+     * 是否有公共响应参数,默认true
+     * <pre>
+     * 如果设置true,返回结果如下
+     * {
+     *     "code": "0",
+     *     "msg": "",
+     *     "sub_code": "",
+     *     "sub_msg": "",
+     *     "data": {
+     *         "id": 1,
+     *         "name": "Jim"
+     *     }
+     * }
+     * 如果设置false,只返回data部分:
+     * {
+     *  "id": 1,
+     *  "name": "Jim"
+     * }
+     * </pre>
+     */
+    boolean hasCommonResponse() default true;
+
 }

sop-support/sop-service-support/src/main/java/com/gitee/sop/support/register/ApiRegister.java

@@ -5,6 +5,7 @@ import com.gitee.sop.support.annotation.Open;
 import com.gitee.sop.support.service.ApiRegisterService;
 import com.gitee.sop.support.service.dto.RegisterDTO;
 import com.gitee.sop.support.service.dto.RegisterResult;
+import io.swagger.annotations.ApiOperation;
 import lombok.Data;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -109,6 +110,11 @@ public class ApiRegister {
         registerDTO.setParamInfo(JSON.toJSONString(paramInfos));
         registerDTO.setIsPermission(parseBoolean(open.permission()));
         registerDTO.setIsNeedToken(parseBoolean(open.needToken()));
+        registerDTO.setHasCommonResponse(parseBoolean(open.hasCommonResponse()));
+        ApiOperation apiOperation = method.getAnnotation(ApiOperation.class);
+        if (apiOperation != null) {
+            registerDTO.setDescription(apiOperation.value());
+        }
         LOG.info("注册开放接口, apiInfo=" + registerDTO);
         RegisterResult result = apiRegisterService.register(registerDTO);
         if (!result.getSuccess()) {

sop-support/sop-service-support/src/main/java/com/gitee/sop/support/service/dto/RegisterDTO.java

@@ -61,5 +61,10 @@ public class RegisterDTO implements Serializable {
      */
     private Integer isNeedToken;
 
+    /**
+     * 是否有公共响应参数
+     */
+    private Integer hasCommonResponse;
+
 
 }