上报controller加入swagger注解

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/FeedbackFileLogController.java

@@ -10,6 +10,7 @@ import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -19,6 +20,7 @@ import java.util.Map;
 @RestController
 @RequestMapping("feedbackFileLog")
 @Slf4j
+@ApiIgnore
 public class FeedbackFileLogController {
   @Autowired FeedbackFileLogService feedbackFileLogService;
 

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/GenerateUploadFileController.java

@@ -7,6 +7,7 @@ import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import springfox.documentation.annotations.ApiIgnore;
 
 /**
  * 生成上报文件，被动于综合通信请求
@@ -17,6 +18,7 @@ import org.springframework.web.bind.annotation.RestController;
 @RequestMapping
 @RestController
 @Slf4j
+@ApiIgnore
 public class GenerateUploadFileController {
 
   @Autowired

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadFileChannelController.java

@@ -5,8 +5,13 @@ import com.jiayue.ipfcst.common.core.web.vo.ResponseVO;
 import com.jiayue.ipfcst.common.data.constant.enums.*;
 import com.jiayue.ipfcst.common.data.entity.UploadFileChannel;
 import com.jiayue.ipfcst.common.data.repository.UploadURLRepository;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadFileChannelService;
 import com.jiayue.ipfcst.fileupload.service.UploadURLService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -25,6 +30,7 @@ import java.util.Map;
 @RestController
 @Slf4j
 @RequestMapping("uploadFileChannel")
+@Api(value = "UploadFileChannelController", tags = "上报通道controller")
 public class UploadFileChannelController {
 
   private final UploadFileChannelService uploadFileChannelService;
@@ -47,6 +53,13 @@ public class UploadFileChannelController {
   @SneakyThrows
   @PostMapping
   @SaveValidate
+  @ApiOperation(value = "新增通道", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileChannel实体</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileChannel",value = "UploadFileChannel实体",dataType="UploadFileChannel")
+  })
+  @ApiMyResponse
   public ResponseVO add(@RequestBody UploadFileChannel uploadFileChannel) {
     UploadFileChannel save = uploadFileChannelService.save(uploadFileChannel);
     return ResponseVO.success(save);
@@ -62,6 +75,13 @@ public class UploadFileChannelController {
   @PutMapping
   @SaveValidate
   @Transactional
+  @ApiOperation(value = "修改通道", httpMethod = "PUT",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileChannel实体</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileChannel",value = "UploadFileChannel实体",dataType="UploadFileChannel")
+  })
+  @ApiMyResponse
   public ResponseVO update(@RequestBody UploadFileChannel uploadFileChannel) {
 
     uploadFileChannelService.save(uploadFileChannel);
@@ -84,6 +104,13 @@ public class UploadFileChannelController {
   @SneakyThrows
   @DeleteMapping("/{id}")
   @SaveValidate
+  @ApiOperation(value = "修改通道", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO delete(@PathVariable Integer id) {
     UploadFileChannel uploadFileChannel = uploadFileChannelService.getById(id);
     uploadFileChannelService.delete(uploadFileChannel);
@@ -98,6 +125,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping
+  @ApiOperation(value = "查询通道", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入List&ltUploadFileChannel&gt</p>"
+  )
+  @ApiMyResponse
   public ResponseVO get() {
     List<UploadFileChannel> uploadFileChannels = uploadFileChannelService.get();
     return ResponseVO.success(uploadFileChannels);
@@ -124,6 +155,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getChannelStatusEnum")
+  @ApiOperation(value = "获取通道状态枚举类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入ChannelStatusEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getChannelStatusEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -150,6 +185,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getUploadProtocolEnum")
+  @ApiOperation(value = "获取上报协议枚举类", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadProtocolEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadProtocolEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -177,6 +216,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getUploadFileCharSetEnum")
+  @ApiOperation(value = "获取上报文件字符集", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileCharSetEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadFileCharSetEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -203,6 +246,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getUploadFileNameLengthEnum")
+  @ApiOperation(value = "获取上报文件名称长度枚举", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileNameLengthEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadFileNameLengthEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -229,6 +276,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getUploadFileSingleByteEnum")
+  @ApiOperation(value = "获取上报文件单次传输字节枚举类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileSingleByteEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadFileSingleByteEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -255,6 +306,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getFtpPassiveModeEnum")
+  @ApiOperation(value = "获取ftp模式", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FtpPassiveModeEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFtpPassiveModeEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -281,6 +336,10 @@ public class UploadFileChannelController {
    */
   @SneakyThrows
   @GetMapping(value = "/getChannelFileRuleEnum")
+  @ApiOperation(value = "获取通道文件生成规则", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入ChannelFileRuleEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getChannelFileRuleEnum() {
     List<Map<String, Object>> list = new ArrayList<>();
     Map<String, Object> map;
@@ -308,6 +367,13 @@ public class UploadFileChannelController {
   @SneakyThrows
   @DeleteMapping("/deleteByObjId/{id}")
   @SaveValidate
+  @ApiOperation(value = "根据对象ID删除通道", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO deleteByObjId(@PathVariable Integer id) {
     try {
       uploadFileChannelService.deleteByObjId(id);

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadFileCodeController.java

@@ -3,7 +3,12 @@ package com.jiayue.ipfcst.fileupload.controller;
 import com.jiayue.ipfcst.aop.SaveValidate;
 import com.jiayue.ipfcst.common.core.web.vo.ResponseVO;
 import com.jiayue.ipfcst.common.data.entity.UploadFileCode;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadFileCodeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -11,6 +16,7 @@ import java.util.List;
 
 @RestController
 @RequestMapping("uploadFileCode")
+@Api(value = "UploadFileCodeController", tags = "上报文件CODE码controller")
 public class UploadFileCodeController {
   @Autowired
   private UploadFileCodeService uploadFileCodeService;
@@ -26,6 +32,10 @@ public class UploadFileCodeController {
    * @return
    */
   @GetMapping
+  @ApiOperation(value = "获取文件类型code数据", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入List&ltUploadFileCode&gt</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getAll(){
     List<UploadFileCode> uploadFileCodes = uploadFileCodeService.get();
     return ResponseVO.success(uploadFileCodes);
@@ -39,6 +49,13 @@ public class UploadFileCodeController {
    */
   @PostMapping
   @SaveValidate
+  @ApiOperation(value = "修改文件类型code数据", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileCode实体</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileCode",value = "UploadFileCode实体",dataType="UploadFileCode")
+  })
+  @ApiMyResponse
   public ResponseVO update(@RequestBody UploadFileCode uploadFileCode){
     return ResponseVO.success(uploadFileCodeService.save(uploadFileCode));
   }
@@ -51,6 +68,13 @@ public class UploadFileCodeController {
    */
   @PutMapping
   @SaveValidate
+  @ApiOperation(value = "新增文件类型code数据", httpMethod = "PUT",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadFileCode实体</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileCode",value = "UploadFileCode实体",dataType="UploadFileCode")
+  })
+  @ApiMyResponse
   public ResponseVO add(@RequestBody UploadFileCode uploadFileCode){
     return ResponseVO.success(uploadFileCodeService.save(uploadFileCode));
   }
@@ -63,6 +87,13 @@ public class UploadFileCodeController {
    */
   @DeleteMapping("/{id}")
   @SaveValidate
+  @ApiOperation(value = "删除文件类型code数据", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO delete(@PathVariable Integer id){
     UploadFileCode uploadFileCode = new UploadFileCode();
     uploadFileCode.setId(id);

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadFileLogController.java

@@ -5,7 +5,12 @@ import com.jiayue.ipfcst.common.data.constant.enums.FileStatusEnum;
 import com.jiayue.ipfcst.common.data.constant.enums.FileTypeEnum;
 import com.jiayue.ipfcst.common.data.constant.enums.UploadProtocolEnum;
 import com.jiayue.ipfcst.common.data.entity.UploadFileLog;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadFileLogService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
@@ -19,6 +24,7 @@ import java.util.Map;
 @RestController
 @RequestMapping("uploadFileLog")
 @Slf4j
+@Api(value = "UploadFileLogController", tags = "上报文件日志controller")
 public class UploadFileLogController {
 
   private final UploadFileLogService uploadFileLogService;
@@ -29,7 +35,7 @@ public class UploadFileLogController {
   }
 
   /**
-   * 根据上报对象，时间，文件类型，文件状态
+   * 根据上报对象、时间、文件类型、文件状态查询文件日志
    *
    * @param uploadObjectId 上报对象
    * @param createTime     时间
@@ -38,6 +44,16 @@ public class UploadFileLogController {
    * @return
    */
   @GetMapping("getFileLog/{uploadObjectId}/{createTime}/{fileType}/{fileStatus}")
+  @ApiOperation(value = "根据上报对象、时间、文件类型、文件状态查询文件日志", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入Page&ltUploadFileLog&gt</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadObjectId",value = "对象ID",dataType="Integer"),
+    @ApiImplicitParam(name= "createTime",value = "生成时间",dataType="String"),
+    @ApiImplicitParam(name= "fileType",value = "文件类型",dataType="String"),
+    @ApiImplicitParam(name= "fileStatus",value = "文件状态",dataType="String"),
+  })
+  @ApiMyResponse
   public ResponseVO get(@PathVariable("uploadObjectId") Integer uploadObjectId, @PathVariable("createTime") String createTime,
                         @PathVariable("fileType") String fileType, @PathVariable("fileStatus") String fileStatus) {
     List<UploadFileLog> list = uploadFileLogService.queryFileLog(uploadObjectId, createTime, fileType, fileStatus);
@@ -45,6 +61,10 @@ public class UploadFileLogController {
   }
 
   @GetMapping("/getFileStatusEnum")
+  @ApiOperation(value = "获取文件状态类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FileStatusEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFileStatusEnum() {
     List list = new ArrayList<>();
     for (FileStatusEnum fileStatusEnum : FileStatusEnum.values()) {
@@ -57,6 +77,10 @@ public class UploadFileLogController {
   }
 
   @GetMapping("/getUploadProtocolEnum")
+  @ApiOperation(value = "获取上报协议", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入UploadProtocolEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadProtocolEnum() {
     List list = new ArrayList<>();
     for (UploadProtocolEnum uploadProtocolEnum : UploadProtocolEnum.values()) {
@@ -69,6 +93,10 @@ public class UploadFileLogController {
   }
 
   @GetMapping("/getFileTypeEnum")
+  @ApiOperation(value = "获取文件类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FileTypeEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFileTypeEnum() {
     List list = new ArrayList<>();
     for (FileTypeEnum fileTypeEnum : FileTypeEnum.values()) {
@@ -81,6 +109,15 @@ public class UploadFileLogController {
   }
 
   @PostMapping("/uploadFile")
+  @ApiOperation(value = "上传文件", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "file",value = "文件",dataType="MultipartFile"),
+    @ApiImplicitParam(name= "uploadObject",value = "对象ID",dataType="String"),
+    @ApiImplicitParam(name= "FileTypeEnum",value = "文件类型",dataType="String"),
+  })
+  @ApiMyResponse
   public ResponseVO uploadFile(@RequestParam("file") MultipartFile file, @RequestParam("uploadObject") String id, @RequestParam("FileTypeEnum") String fileType) {
     Integer objectId = Integer.parseInt(id);
 
@@ -90,17 +127,29 @@ public class UploadFileLogController {
     }else {
       return ResponseVO.fail("上传失败！");
     }
-
-
   }
 
   @DeleteMapping("/{id}")
+  @ApiOperation(value = "根据主键ID删除文件", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO deleteById(@PathVariable("id") Integer id){
     uploadFileLogService.deleteById(id);
     return ResponseVO.success(1);
   }
 
   @PostMapping("/cleanCache")
+  @ApiOperation(value = "清楚文件缓存", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileLog",value = "UploadFileLog实体",dataType="UploadFileLog")
+  })
+  @ApiMyResponse
   public ResponseVO cleanCache(@RequestBody UploadFileLog uploadFileLog){
     uploadFileLogService.cleanCache(uploadFileLog);
     return ResponseVO.success(1);
@@ -113,6 +162,13 @@ public class UploadFileLogController {
    * @return
    */
   @PostMapping("/report")
+  @ApiOperation(value = "文件补报", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileLog",value = "UploadFileLog实体",dataType="UploadFileLog")
+  })
+  @ApiMyResponse
   public ResponseVO report(@RequestBody UploadFileLog uploadFileLog){
     uploadFileLogService.report(uploadFileLog);
     return ResponseVO.success(1);
@@ -124,6 +180,13 @@ public class UploadFileLogController {
    * @return
    */
   @PostMapping("/quickReport")
+  @ApiOperation(value = "一键文件补报", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadFileLogList",value = "UploadFileLog实体",dataType="List")
+  })
+  @ApiMyResponse
   public ResponseVO quickReport(@RequestBody List<UploadFileLog> uploadFileLogList){
     uploadFileLogService.quickReport(uploadFileLogList);
     return ResponseVO.success(1);

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadFileLogDetailController.java

@@ -6,12 +6,14 @@ import com.jiayue.ipfcst.fileupload.service.UploadFileLogDetailService;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.List;
 
 @RestController
 @RequestMapping("uploadFileLogDetail")
 @Slf4j
+@ApiIgnore
 public class UploadFileLogDetailController {
   private final UploadFileLogDetailService uploadFileLogDetailService;
   @Autowired

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadFileOpenInterfaceController.java

@@ -2,12 +2,18 @@ package com.jiayue.ipfcst.fileupload.controller;
 
 import com.jiayue.ipfcst.common.core.web.vo.ResponseVO;
 import com.jiayue.ipfcst.common.data.entity.UploadFileLog;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadFileLogService;
 import com.jiayue.ipfcst.fileupload.util.FileConstant;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -22,6 +28,7 @@ import java.util.Map;
 @RestController
 @RequestMapping("uploadFileOpenInterface")
 @Slf4j
+@Api(value = "UploadFileOpenInterfaceController", tags = "给reportquery提供接口controller")
 public class UploadFileOpenInterfaceController {
 
   private final UploadFileLogService uploadFileLogService;
@@ -35,6 +42,10 @@ public class UploadFileOpenInterfaceController {
    * @return
    */
   @RequestMapping(value = "/getFileCache")
+  @ApiOperation(value = "查看上报缓存中的文件", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FileConstant.readyUploadFileMap文件缓存</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFileCache() {
     log.info("访问上报缓存。。。。。。。");
     List list = new ArrayList<>();
@@ -52,6 +63,7 @@ public class UploadFileOpenInterfaceController {
    * @return
    */
   @RequestMapping(value = "/updateD5000FileStatus/{remoteIp}/{fileName}/{uploadStatus}")
+  @ApiIgnore
   public String updateD5000FileStatus(@PathVariable final String remoteIp, @PathVariable final String fileName, @PathVariable final String uploadStatus) {
     try {
       uploadFileLogService.updateD5000FileStatus(remoteIp, fileName,uploadStatus);
@@ -67,6 +79,10 @@ public class UploadFileOpenInterfaceController {
    * @return
    */
   @RequestMapping(value = "/getUploadObjectStatus")
+  @ApiOperation(value = "获取上报对象状态", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FileConstant.channelStatusMap上报通道状态</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getUploadObjectStatus() {
     log.info("获取上报对象状态。。。。。。。");
     List list = new ArrayList<>();

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadObjectController.java

@@ -6,11 +6,17 @@ import com.jiayue.ipfcst.common.core.web.vo.ResponseVO;
 import com.jiayue.ipfcst.common.data.constant.enums.FileTypeEnum;
 import com.jiayue.ipfcst.common.data.entity.*;
 import com.jiayue.ipfcst.common.data.repository.UploadObjectRepository;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadFileChannelService;
 import com.jiayue.ipfcst.fileupload.service.UploadObjectService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
+import springfox.documentation.annotations.ApiIgnore;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -21,6 +27,7 @@ import java.util.stream.Collectors;
 @RestController
 @RequestMapping("uploadObject")
 @Slf4j
+@Api(value = "UploadObjectController", tags = "上报对象controller")
 public class UploadObjectController {
   @Autowired
   private final UploadObjectService uploadObjectService;
@@ -37,6 +44,10 @@ public class UploadObjectController {
    * @return
    */
   @GetMapping()
+  @ApiOperation(value = "获取通道对象", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入Page&ltUploadObject&gt</p>"
+  )
+  @ApiMyResponse
   public ResponseVO get() {
     List list = new ArrayList();
     List<UploadObject> uploadObjectList = uploadObjectService.get();
@@ -51,6 +62,13 @@ public class UploadObjectController {
    */
   @PostMapping
   @SaveValidate
+  @ApiOperation(value = "保存通道对象", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadObject",value = "UploadObject实体",dataType="UploadObject")
+  })
+  @ApiMyResponse
   public ResponseVO add(@RequestBody UploadObject uploadObject) {
     try {
       uploadObjectService.save(uploadObject);
@@ -69,6 +87,13 @@ public class UploadObjectController {
    */
   @PutMapping
   @SaveValidate
+  @ApiOperation(value = "更新通道对象", httpMethod = "PUT",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadObject",value = "UploadObject实体",dataType="UploadObject")
+  })
+  @ApiMyResponse
   public ResponseVO update(@RequestBody UploadObject uploadObject) {
     try {
       uploadObjectService.save(uploadObject);
@@ -88,6 +113,13 @@ public class UploadObjectController {
    */
   @DeleteMapping("/{id}")
   @SaveValidate
+  @ApiOperation(value = "删除通道对象", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO delete(@PathVariable Integer id) {
     try {
       uploadFileChannelService.deleteByObjId(id);
@@ -104,6 +136,10 @@ public class UploadObjectController {
    * 获取文件上报类型
    */
   @GetMapping("getFileType")
+  @ApiOperation(value = "获取文件上报类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入FileTypeEnum枚举</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFileType() {
     List list = new ArrayList();
     try {
@@ -128,6 +164,13 @@ public class UploadObjectController {
    * @return UploadObject 上报对象
    */
   @GetMapping("getByuploadObjectId/{uploadObjectId}")
+  @ApiOperation(value = "根据上报id查询对象", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入List&ltUploadObject&gt</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadObjectId",value = "uploadObjectId对象ID",dataType="Integer"),
+  })
+  @ApiMyResponse
   public ResponseVO getFileTypeByupId(@PathVariable("uploadObjectId") Integer uploadObjectId){
     List list = new ArrayList();
     UploadObject uploadObject = uploadObjectRepository.findById(uploadObjectId).get();
@@ -139,6 +182,10 @@ public class UploadObjectController {
    * 获取对应省份的上报文件类型
    */
   @GetMapping("getFileTypeByProvince")
+  @ApiOperation(value = "获取对应省份的上报文件类型", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入省份所属的文件类型集合</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getFileTypeByProvince(){
     Map<String, String> uploadFileType = uploadObjectService.getUploadFileType();
     List<Map<String, String>> list = new ArrayList<>();
@@ -159,6 +206,10 @@ public class UploadObjectController {
    * 获取所有FTPSFTP通道 whc
    */
   @GetMapping("getFtpSftpChannel")
+  @ApiOperation(value = "获取所有FTPSFTP通道", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入List&ltUploadFileChannel&gt</p>"
+  )
+  @ApiMyResponse
   public ResponseVO getAllFtpSftp(){
     //获取所有上报对象
     List<UploadObject> uploadObjectList = uploadObjectService.get();
@@ -187,6 +238,7 @@ public class UploadObjectController {
    * @return Boolean
    */
   @GetMapping("/checkE402")
+  @ApiIgnore
   public ResponseVO checkE402() throws BusinessException {
 
     return ResponseVO.success(uploadObjectService.checkE402());

ipfcst/ipfcst-console/src/main/java/com/jiayue/ipfcst/fileupload/controller/UploadURLController.java

@@ -2,7 +2,12 @@ package com.jiayue.ipfcst.fileupload.controller;
 
 import com.jiayue.ipfcst.common.core.web.vo.ResponseVO;
 import com.jiayue.ipfcst.common.data.entity.UploadURL;
+import com.jiayue.ipfcst.common.data.strategy.ApiMyResponse;
 import com.jiayue.ipfcst.fileupload.service.UploadURLService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.*;
@@ -10,12 +15,20 @@ import org.springframework.web.bind.annotation.*;
 import java.util.List;
 
 @RestController
+@Api(value = "UploadURLController", tags = "sftp/sftp上报路径controller")
 public class UploadURLController {
   @Autowired
   private UploadURLService uploadURLService;
 
   @GetMapping("/uploadURL/{uploadChannelId}")
   @Transactional
+  @ApiOperation(value = "根据通道id获取路径", httpMethod = "GET",
+    notes = "<p>返回ResponseVO对象，data属性存入List&ltUploadURL&gt</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadChannelId",value = "通道ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO findByUploadChannelId(@PathVariable Integer uploadChannelId){
     List<UploadURL> byUploadCahnnelId = uploadURLService.findByUploadCahnnelId(uploadChannelId);
 
@@ -24,8 +37,14 @@ public class UploadURLController {
 
   @PostMapping("/uploadURL")
   @Transactional
+  @ApiOperation(value = "保存路径", httpMethod = "POST",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "uploadURL",value = "UploadURL实体",dataType="UploadURL")
+  })
+  @ApiMyResponse
   public ResponseVO save(@RequestBody UploadURL uploadURL){
-
     uploadURLService.save(uploadURL);
     return ResponseVO.success();
   }
@@ -33,6 +52,13 @@ public class UploadURLController {
 
   @DeleteMapping("/uploadURL/{id}")
   @Transactional
+  @ApiOperation(value = "删除路径", httpMethod = "DELETE",
+    notes = "<p>返回ResponseVO对象</p>"
+  )
+  @ApiImplicitParams(value={
+    @ApiImplicitParam(name= "id",value = "主键ID",dataType="Integer")
+  })
+  @ApiMyResponse
   public ResponseVO delete(@PathVariable Integer id){
 
     uploadURLService.deleteByChannelId(id);