合并

src/main/java/com/huiju/estateagents/controller/TaChannelController.java

@@ -6,7 +6,7 @@ import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
 import com.huiju.estateagents.base.BaseController;
 import com.huiju.estateagents.base.ResponseBean;
-
+import io.swagger.annotations.ApiOperation;
 import com.huiju.estateagents.common.JWTUtils;
 import com.huiju.estateagents.common.StringUtils;
 import com.huiju.estateagents.entity.TaChannel;
@@ -14,6 +14,9 @@ import com.huiju.estateagents.entity.TaPerson;
 import com.huiju.estateagents.mapper.TaChannelMapper;
 import com.huiju.estateagents.service.ITaPersonService;
 import com.huiju.estateagents.service.TaChannelService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
 import org.apache.http.HttpRequest;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -41,6 +44,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "渠道管理", tags = "渠道管理")
 public class TaChannelController extends BaseController {
 
     private final Logger logger = LoggerFactory.getLogger(TaChannelController.class);
@@ -56,11 +60,17 @@ public class TaChannelController extends BaseController {
 
 
     /**
-     * 分页查询列表
+     * 渠道管理列表
      * @param pageNum
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "渠道管理列表", notes = "渠道管理列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "channelId", paramType = "query",value = "渠道Id"),
+    })
     @RequestMapping(value="/admin/channel",method= RequestMethod.GET)
     public ResponseBean channelList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                     @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -87,10 +97,14 @@ public class TaChannelController extends BaseController {
     }
 
     /**
-     * 保存对象
+     * 渠道保存
      * @param channel 实体对象
      * @return
      */
+    @ApiOperation(value = "渠道保存", notes = "渠道保存")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = TaChannel.class, name = "channel", paramType = "body",value = "当前对象"),
+    })
     @RequestMapping(value="/admin/channel",method= RequestMethod.POST)
     public ResponseBean channelAdd(@RequestBody TaChannel channel ,HttpServletRequest request){
         Integer orgId = getOrgId(request);
@@ -117,6 +131,10 @@ public class TaChannelController extends BaseController {
      * 根据id删除对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "根据渠道ID删除", notes = "根据渠道ID删除")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "query",value = "渠道id"),
+    })
     @ResponseBody
     @RequestMapping(value="/channel/{id}", method= RequestMethod.DELETE)
     public ResponseBean channelDelete(@PathVariable Integer id){
@@ -141,6 +159,10 @@ public class TaChannelController extends BaseController {
      * @param channel 实体对象
      * @return
      */
+    @ApiOperation(value = "根据渠道ID修改", notes = "根据渠道ID修改")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "query",value = "渠道id"),
+    })
     @RequestMapping(value="/admin/channel/{id}",method= RequestMethod.PUT)
     public ResponseBean channelUpdate(@PathVariable Integer id,
                                         @RequestBody TaChannel channel){
@@ -164,6 +186,10 @@ public class TaChannelController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "根据渠道ID查询", notes = "根据渠道ID查询")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "query",value = "渠道id"),
+    })
     @RequestMapping(value="/admin/channel/{id}",method= RequestMethod.GET)
     public ResponseBean channelGet(@PathVariable Integer id){
         ResponseBean responseBean = new ResponseBean();
@@ -180,6 +206,14 @@ public class TaChannelController extends BaseController {
     /**
      * 渠道管理下的经纪人
      */
+    @ApiOperation(value = "渠道管理下的经纪人", notes = "渠道管理下的经纪人")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, name = "name", paramType = "query",value = "姓名"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "phone", paramType = "query",value = "电话"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "channelId", paramType = "query",value = "渠道id"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "多少页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "每页多少条"),
+    })
     @RequestMapping(value="/admin/channel/broker",method= RequestMethod.GET)
     public  ResponseBean channelBrokerList(@RequestParam(value="name",required = false) String name,
                                            @RequestParam(value="phone",required = false) String phone,
@@ -195,6 +229,14 @@ public class TaChannelController extends BaseController {
     /**
      * 渠道邀请经纪人
      */
+    @ApiOperation(value = "渠道邀请经纪人", notes = "渠道邀请经纪人")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, name = "id", paramType = "query",value = "姓名"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "phone", paramType = "query",value = "电话"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "channelId", paramType = "query",value = "渠道id"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "多少页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "每页多少条"),
+    })
     @RequestMapping(value="/admin/channel/InviteClientsList",method= RequestMethod.GET)
     public  ResponseBean InviteClientsList(@RequestParam(value="id",required = false) String id,
                                            @RequestParam(value="phone",required = false) String phone,