增加接口描述

src/main/java/cn/quantgroup/xyqb/controller/internal/user/InnerController.java

@@ -8,6 +8,7 @@ import cn.quantgroup.xyqb.aspect.accessable.IpValidator;
 import cn.quantgroup.xyqb.controller.IBaseController;
 import cn.quantgroup.xyqb.controller.internal.user.resp.UserFullResp;
 import cn.quantgroup.xyqb.entity.*;
+import cn.quantgroup.xyqb.entity.Contact;
 import cn.quantgroup.xyqb.event.DisableActiveEvent;
 import cn.quantgroup.xyqb.event.UserExtInfoSaveEvent;
 import cn.quantgroup.xyqb.exception.UserNotExistException;
@@ -31,10 +32,8 @@ import com.alibaba.fastjson.JSONObject;
 import com.alibaba.fastjson.TypeReference;
 import com.google.common.base.MoreObjects;
 import com.google.common.collect.Maps;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
+import io.swagger.annotations.*;
 import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.lang3.StringUtils;
@@ -59,6 +58,7 @@ import java.util.stream.Collectors;
 /**
  * Created by Miraculous on 2016/12/19.
  */
+@Api(tags = "innerapi API")
 @Slf4j
 @RestController
 @RequestMapping("/innerapi")
@@ -952,11 +952,13 @@ public class InnerController implements IBaseController {
      * @param userId 用户id
      * @return
      */
+    @ApiOperation(value = "查询用户全量信息", httpMethod = "POST", notes="查询用户全量信息")
     @GetMapping("/user-full/search/userId")
     public JsonResult<UserFullResp> findUserFullSearchByUserId(@RequestParam Long userId) {
         return JsonResult.buildSuccessResultGeneric(userService.findUserFullSearchByUserId(userId));
     }
 
+    @ApiOperation(value = "不知道干嘛的", httpMethod = "POST", notes="不知道干嘛的")
     @RequestMapping("/user-association/search/phone")
     public JsonResult findUserAssociationByPhone(String phoneNo) {
         UserDetail userDetail = userDetailService.findByPhoneNo(phoneNo);
@@ -964,6 +966,7 @@ public class InnerController implements IBaseController {
         return JsonResult.buildSuccessResult("", bean);
     }
 
+    @ApiOperation(value = "不知道干嘛的", httpMethod = "POST", notes="不知道干嘛的")
     @RequestMapping("/user-association/search/uid")
     public JsonResult findUserAssociationByUid(Long uid) {
         UserDetail userDetail = userDetailService.findByUserId(uid);
@@ -1044,6 +1047,7 @@ public class InnerController implements IBaseController {
         return contactRets;
     }
 
+    @ApiOperation(value = "通过手机号查询openId", httpMethod = "POST", notes="通过手机号查询openId")
     @RequestMapping("/user/wechat/phone_no")
     public JsonResult queryOpenIdByPhoneNo(String phoneNo) {
         if (StringUtils.isBlank(phoneNo)) {
@@ -1491,6 +1495,7 @@ public class InnerController implements IBaseController {
      * 修改实名信息接口
      * -- 供内部人员使用（例如绝影）
      */
+    @ApiOperation(value = "修改实名信息接口", httpMethod = "POST", notes="修改实名信息接口")
     @RequestMapping("/updateIdCard")
     public JsonResult updateIdCard(@RequestParam(required = false) String name, @RequestParam(required = false) String idNo,
                                    @RequestParam String phoneNo, @RequestParam String reason, @RequestParam String content) {
@@ -1529,6 +1534,7 @@ public class InnerController implements IBaseController {
      * 重置密码接口
      * -- 供内部人员使用（例如绝影）
      */
+    @ApiOperation(value = "重置密码接口", httpMethod = "POST", notes="重置密码接口")
     @RequestMapping("/user/password/reset/{key}/{phone}")
     public JsonResult resetPasswordByKey(@PathVariable("key") String key, @PathVariable("phone") String phone) {
         log.info("密码重置请求,phone:[{}]", phone);
@@ -1549,6 +1555,7 @@ public class InnerController implements IBaseController {
      * @param content
      * @return
      */
+    @ApiOperation(value = "禁用 用户", httpMethod = "POST", notes="禁用 用户")
     @RequestMapping("/forbiddenUserOrNot")
     public JsonResult forbiddenUserOrNot(@RequestParam String phoneNo, @RequestParam Boolean enable,
                                          @RequestParam String reason, @RequestParam String content) {
@@ -1592,6 +1599,7 @@ public class InnerController implements IBaseController {
      * @param content
      * @return
      */
+    @ApiOperation(value = "清除微信关联", httpMethod = "POST", notes="清除微信关联")
     @RequestMapping("/forbiddenUserWeChat")
     public JsonResult forbiddenUserWeChat(@RequestParam Long userId, @RequestParam String reason, @RequestParam String content) {
         if (StringUtils.isBlank(reason) || null == userId || userId <= 0) {
@@ -1622,6 +1630,7 @@ public class InnerController implements IBaseController {
      * @param userId 用户id
      * @return 销户结果
      */
+    @ApiOperation(value = "注销用户", httpMethod = "GET", notes="注销用户")
     @GetMapping("/user/delete/{userId}")
     public JsonResult<?> delete(@NotNull @PathVariable("userId") Long userId) {