更新api文档

src/main/java/com/fd/controller/ConvertController.java

@@ -23,6 +23,7 @@ import javax.servlet.http.HttpServletResponse;
  * <p>
  * GWS84 转 CGCS2000 坐标系
  */
+@ApiIgnore
 @Api(tags = "坐标转换模块")
 @Log4j2
 @RequestMapping("api/convert")

src/main/java/com/fd/controller/DemController.java

@@ -7,8 +7,7 @@ import com.fd.dto.PageDto;
 import com.fd.entity.OutputFileEntity;
 import com.fd.server.DemServer;
 import com.fd.util.R;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.*;
 import lombok.extern.log4j.Log4j2;
 import org.apache.shiro.authz.annotation.RequiresRoles;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -24,6 +23,7 @@ import javax.servlet.http.HttpServletRequest;
  * <p>
  * 地形数据
  */
+@ApiIgnore
 @Api(tags = "地形模块")
 @Log4j2
 @RequestMapping("api/dem")
@@ -42,6 +42,7 @@ public class DemController {
      */
     @ApiOperation("上传文件")
     @PostMapping(value = "upload", consumes = {"multipart/form-data"})
+    @ApiImplicitParam(name = "file", value = "文件", dataType = "Array")
     public R upload(@RequestParam("file") MultipartFile[] file, HttpServletRequest req) {
         return demServer.uploads(file, req);
     }
@@ -53,11 +54,25 @@ public class DemController {
      */
     @ApiOperation("数据切片")
     @GetMapping("command/slice/{fileId}/")
+    @ApiImplicitParam(name = "fileId", value = "文件Id", required = true)
     public R cmdSlice(@PathVariable("fileId") Long fileId) {
         return demServer.cmdSlice(fileId);
 
     }
 
+//    @ApiImplicitParams({
+//            @ApiImplicitParam(name = "fileId", value = "相机密码", dataType = "String"),
+////            @ApiImplicitParam(name = "childName", value = "相机的物理地址", dataType = "String")
+//    })
+
+//    @ApiImplicitParam(name = "fileId", value = "相机密码13", dataType = "String")
+//    @GetMapping("test")
+//    @ApiOperation("测试api文档")
+//    public R test(Long fileId) {
+//        return demServer.cmdSlice(fileId);
+//
+//    }
+
 
     @ApiOperation("获取数据列表")
     @PostMapping(value = "list")
@@ -78,7 +93,7 @@ public class DemController {
 //        return new R(200,"1111");
 //    }
 
-
+    @ApiImplicitParam(name = "fileId", value = "文件Id", required = true)
     @ApiOperation("删除文件")
     @GetMapping("delete/{fileId}/")
     public R deleteFile(@PathVariable("fileId") Long fileId) {
@@ -86,7 +101,7 @@ public class DemController {
     }
 
 
-
+    @ApiImplicitParam(name = "fileId", value = "文件Id", required = true)
     @RequiresRoles("admin")
     @ApiOperation("移动数据到服务器上")
     @PostMapping("move/{fileId}/")

src/main/java/com/fd/controller/HeatMapController.java

@@ -22,6 +22,7 @@ import java.util.List;
  *
  * 热力图
  */
+@ApiIgnore
 @Api(tags = "热力图模块")
 @RequestMapping("manage/heatmap")
 @RestController

src/main/java/com/fd/controller/ModelController.java

@@ -13,6 +13,7 @@ import com.fd.util.FileUtils;
 import com.fd.util.R;
 import com.fd.util.RegexUtils;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiOperation;
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.lang3.StringUtils;
@@ -72,6 +73,7 @@ public class ModelController {
 
     @ApiOperation("上传数据，校验文件名")
     @GetMapping("check/{fileName}/")
+    @ApiImplicitParam(name = "fileName", value = "文件名", required = true)
     public R checkFileName(@PathVariable("fileName") String fileName) {
         log.info("run checkFileName {}", fileName);
 
@@ -93,8 +95,9 @@ public class ModelController {
         return new R(200, MsgCode.SUCCESS);
     }
 
-    @ApiOperation("上传3D模型数据，只能上传zip文件")
+    @ApiOperation("上传3D模型数据")
     @PostMapping(value = "upload", consumes = {"multipart/form-data"})
+    @ApiImplicitParam(name = "file", value = "只能上传zip文件", required = true)
     public R upload(@RequestParam("file") MultipartFile file, HttpServletRequest req) {
         log.info("run upload");
         String token = req.getHeader("Authorization");
@@ -122,6 +125,7 @@ public class ModelController {
 
     @ApiOperation("解压zip文件")
     @GetMapping("unzip/{fileId}/")
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     public R fileUnzip(@PathVariable("fileId") Long fileId) {
         log.info("run fileUnzip: {}", fileId);
 
@@ -158,6 +162,7 @@ public class ModelController {
     }
 
 
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("删除文件")
     @GetMapping("delete/{fileId}/")
     public R deleteFile(@PathVariable("fileId") Long fileId) {
@@ -174,7 +179,7 @@ public class ModelController {
         return new R(200, MsgCode.SUCCESS);
     }
 
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("倾斜摄影数据切片")
     @GetMapping("command/osgb/{fileId}/")
     public R cmdModelSlice(@PathVariable("fileId") Long fileId) {
@@ -221,6 +226,7 @@ public class ModelController {
 
     }
 
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @RequiresRoles("admin")
     @ApiOperation("移动数据到服务器上")
     @PostMapping("move/{fileId}/")

src/main/java/com/fd/controller/RasterController.java

@@ -13,6 +13,8 @@ import com.fd.util.FileUtils;
 import com.fd.util.R;
 import com.fd.util.RegexUtils;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
 import io.swagger.annotations.ApiOperation;
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.lang3.StringUtils;
@@ -35,7 +37,7 @@ import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * Created by Owen on 2019/11/12 0012 9:40
- *
+ * <p>
  * 栅格数据
  */
 @Api(tags = "栅格模块")
@@ -68,13 +70,11 @@ public class RasterController {
     private static BlockingQueue<Integer> coordQueue = new LinkedBlockingQueue<Integer>(2);
 
 
-
-
+    @ApiImplicitParam(name = "fileName", value = "文件名", required = true)
     @ApiOperation("上传数据，校验文件名")
     @GetMapping("check/{fileName}/")
     public R checkFileName(@PathVariable("fileName") String fileName) {
-        log.info("run checkFileName: {}",fileName);
-
+        log.info("run checkFileName: {}", fileName);
 
 
         // 文件是否包含中文字符
@@ -86,20 +86,25 @@ public class RasterController {
         String s = StringUtils.substringAfterLast(fileName, ".");
         if (!"tif".equals(s)) {
             log.info(MsgCode.E50008);
-            return new R(50008,MsgCode.E50008);
+            return new R(50008, MsgCode.E50008);
         }
 
         List<FileEntity> list = rasterServer.findByFileName(fileName);
         if (list.size() > 0) {
-            log.info( MsgCode.E51006);
+            log.info(MsgCode.E51006);
             return new R(51006, MsgCode.E51006);
         }
         return new R(200, MsgCode.SUCCESS);
     }
 
-    @ApiOperation("上传栅格数据，只能上传tif文件")
-    @PostMapping(value = "upload", consumes = { "multipart/form-data" })
-    public R upload(@RequestParam("file") MultipartFile file, @RequestParam(value = "coord",required = false) String[] coord, HttpServletRequest req){
+
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "file", value = "只能上传tif文件", required = true),
+            @ApiImplicitParam(name = "coord", value = "坐标参数", dataType = "String"),
+    })
+    @ApiOperation("上传栅格数据")
+    @PostMapping(value = "upload", consumes = {"multipart/form-data"})
+    public R upload(@RequestParam("file") MultipartFile file, @RequestParam(value = "coord", required = false) String[] coord, HttpServletRequest req) {
         log.info("run upload");
         log.info("coord: {}", Arrays.toString(coord));
         String strCoord = Arrays.toString(coord);
@@ -116,7 +121,7 @@ public class RasterController {
 
         String s = StringUtils.substringAfterLast(fileName, ".");
         if (!"tif".equals(s)) {
-            return new R(50008,MsgCode.E50008);
+            return new R(50008, MsgCode.E50008);
         }
 
         List<FileEntity> list = rasterServer.findByFileName(fileName);
@@ -138,9 +143,10 @@ public class RasterController {
 
     /**
      * 上传后判断坐标，显示原始坐标
+     *
      * @return
      */
-    private OutputFileEntity JudgeCoord(OutputFileEntity entity, RasterServer rasterServer){
+    private OutputFileEntity JudgeCoord(OutputFileEntity entity, RasterServer rasterServer) {
 
         String cmd = Command.RASTER_JUDGE_COORD;
         cmd = cmd.replace("@inputFile", entity.getUploadPath());
@@ -150,12 +156,12 @@ public class RasterController {
         Integer isJudge = rasterServer.cmdJudgeCoord(cmd);
 
 
-        if (1000 == isJudge){
+        if (1000 == isJudge) {
             log.info("need to transform");
             // 严格坐标转换
             entity.setCoordType(TypeCode.COORD_XIAN_1980);
 
-        } else if (0 == isJudge){
+        } else if (0 == isJudge) {
             log.info("not to transform");
             entity.setCoordType(TypeCode.COORD_WGS84);
 
@@ -172,15 +178,14 @@ public class RasterController {
 
     @ApiOperation("获取栅格数据列表")
     @PostMapping(value = "list")
-    public R list(@RequestBody PageDto param, HttpServletRequest req){
+    public R list(@RequestBody PageDto param, HttpServletRequest req) {
         String token = req.getHeader("Authorization");
         Page<OutputFileEntity> page = rasterServer.findByList(TypeCode.FILE_TYPE_RASTER, param, token);
         return new R(200, page);
 //        return rasterServer.findByType(TypeCode.FILE_TYPE_RASTER, param);
     }
 
-
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("删除文件")
     @GetMapping("delete/{fileId}/")
     public R deleteFile(@PathVariable("fileId") Long fileId) {
@@ -200,10 +205,7 @@ public class RasterController {
         return new R(200, MsgCode.SUCCESS);
     }
 
-
-
-
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("栅格数据判断坐标")
     @GetMapping("command/judge/coord/{fileId}/")
     public R cmdJudgeCoord(@PathVariable("fileId") Long fileId) {
@@ -218,7 +220,6 @@ public class RasterController {
         log.info("cmd: {}", cmd);
 
 
-
         // 把数据放入队列中
         boolean offer = false;
         try {
@@ -234,7 +235,7 @@ public class RasterController {
             entity.setStatus(9);
             entity.setUpdateTime(new Date());
             entity = rasterServer.save(entity);
-            log.info("coord entity: {}",entity);
+            log.info("coord entity: {}", entity);
             log.info("coord producer update time: {}", entity.getUpdateTime());
 
             asyncTask.rasterJudgeCoordConsumerThread(coordQueue, rasterServer, OUTPUT_FILE_PATH, entity);
@@ -245,17 +246,21 @@ public class RasterController {
     }
 
 
-
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "fileId", value = "文件id", required = true),
+            @ApiImplicitParam(name = "layerMin", value = "图片级别（最小值）", required = true),
+            @ApiImplicitParam(name = "layerMax", value = "图片级别（最大值）",  required = true)
+    })
     @ApiOperation("栅格数据切片命令")
     @GetMapping("command/osgeo/{fileId}/{layerMin}/{layerMax}/")
     public R cmdSlice(@PathVariable("fileId") Long fileId, @PathVariable("layerMin") String layerMin, @PathVariable("layerMax") String layerMax) {
         log.info("run cmdSlice: {}", fileId);
 
-        if (!RegexUtils.regexInt(layerMin)){
-            return new R(50010, MsgCode.E50010) ;
+        if (!RegexUtils.regexInt(layerMin)) {
+            return new R(50010, MsgCode.E50010);
         }
-        if (!RegexUtils.regexInt(layerMax)){
-            return new R(50010, MsgCode.E50010) ;
+        if (!RegexUtils.regexInt(layerMax)) {
+            return new R(50010, MsgCode.E50010);
         }
 
 
@@ -275,7 +280,6 @@ public class RasterController {
         log.info("cmd: {}", cmd);
 
 
-
         // 把数据放入队列中
         boolean offer = false;
 
@@ -300,13 +304,12 @@ public class RasterController {
 
             asyncTask.rasterSliceThread(sliceQueue, rasterServer, entity, cmd);
 
-            return new R(200, entity) ;
+            return new R(200, entity);
         }
         return new R(52000, MsgCode.E52000);
     }
 
-
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("栅格数据进度查询")
     @GetMapping("progress/{fileId}/")
     public R getProgress(@PathVariable("fileId") Long fileId) {
@@ -314,6 +317,7 @@ public class RasterController {
         return new R(200, entity);
     }
 
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @RequiresRoles("admin")
     @ApiOperation("移动数据到服务器上")
     @PostMapping("move/{fileId}/")

src/main/java/com/fd/controller/UserController.java

@@ -6,6 +6,9 @@ import com.fd.repository.UserRepository;
 import com.fd.shiro.JWTUtil;
 import com.fd.util.R;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.log4j.Log4j2;
 import org.apache.shiro.SecurityUtils;
 import org.apache.shiro.authz.UnauthorizedException;
@@ -40,6 +43,11 @@ public class UserController {
 
     private static final String SALT = "cesium_";
 
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "username", value = "用户名", required = true),
+            @ApiImplicitParam(name = "password", value = "密码", required = true)
+    })
+    @ApiOperation("登录")
     @PostMapping("/login")
     public R login(@RequestParam("username") String username,
                    @RequestParam("password") String password) {
@@ -69,7 +77,7 @@ public class UserController {
     }
 
 
-
+    @ApiOperation("退出")
     @GetMapping("/logout")
     public R logout(HttpServletRequest request) {
         log.info("run logout");

src/main/java/com/fd/controller/VectorController.java

@@ -16,6 +16,8 @@ import com.fd.util.FileUtils;
 import com.fd.util.R;
 import com.fd.util.RegexUtils;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
 import io.swagger.annotations.ApiOperation;
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.lang3.StringUtils;
@@ -95,7 +97,12 @@ public class VectorController {
     private static AtomicInteger sliceCount = new AtomicInteger();
 
 
-    @ApiOperation("上传矢量数据, coord：坐标(可以为空), 坐标格式：0,0,0,0,0,0,0")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "file", value = "矢量数据文件", required = true),
+            @ApiImplicitParam(name = "coord", value = "坐标参数", required = false),
+            @ApiImplicitParam(name = "directoryName", value = "目录名称",  required = true)
+    })
+    @ApiOperation("上传矢量数据")
     @PostMapping(value = "uploadMult/{directoryName}", consumes = {"multipart/form-data"})
     public R uploadMult(@RequestParam("file") MultipartFile[] file,
                          @PathVariable("directoryName") String directoryName,
@@ -202,6 +209,7 @@ public class VectorController {
     /**
      * 删除文件
      */
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("删除文件")
     @GetMapping("delete/{fileId}/")
     public R deleteFile(@PathVariable("fileId") Long fileId) {
@@ -222,7 +230,7 @@ public class VectorController {
 
 
 
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("矢量数据判断坐标")
     @GetMapping("command/judge/coord/{fileId}/")
     public R cmdJudgeCoord(@PathVariable("fileId") Long fileId) {
@@ -269,8 +277,8 @@ public class VectorController {
 
 
 
-
-    @ApiOperation("矢量数据转geojson")
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
+    @ApiOperation("矢量数据转geoJson")
     @GetMapping("command/geojson/{fileId}/")
     public R cmdGeojson(@PathVariable("fileId") Long fileId) {
         log.info("run cmdGeojson: {}", fileId);
@@ -306,7 +314,11 @@ public class VectorController {
         return new R(200, entity);
     }
 
-
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "fileId", value = "文件id", required = true),
+            @ApiImplicitParam(name = "layerMin", value = "图片级别（最小值）", required = true),
+            @ApiImplicitParam(name = "layerMax", value = "图片级别（最大值）",  required = true)
+    })
     @ApiOperation("矢量数据切片")
     @GetMapping("command/slice/{fileId}/{layerMin}/{layerMax}/")
     public R cmdSlice(@PathVariable("fileId") Long fileId, @PathVariable("layerMin") String layerMin, @PathVariable("layerMax") String layerMax) {
@@ -361,7 +373,7 @@ public class VectorController {
 
 
 
-
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("矢量数据进度查询")
     @GetMapping("progress/{fileId}/")
     public R getProgress(@PathVariable("fileId") Long fileId) {
@@ -369,6 +381,7 @@ public class VectorController {
         return new R(200, entity);
     }
 
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @RequiresRoles("admin")
     @ApiOperation("移动数据到服务器上")
     @PostMapping("move/{fileId}/")
@@ -378,7 +391,6 @@ public class VectorController {
     }
 
 
-
     @ApiOperation("保存样式")
     @PostMapping("style/save/")
     public R saveStyle(@RequestBody StyleDto param) {
@@ -386,6 +398,7 @@ public class VectorController {
         return vectorServer.editStyle(param);
     }
 
+    @ApiImplicitParam(name = "fileId", value = "文件id", required = true)
     @ApiOperation("获取样式")
     @GetMapping("style/get/{fileId}/")
     public R getStyle(@PathVariable("fileId") Long fileId) {

src/main/java/com/fd/controller/WfsController.java

@@ -6,6 +6,7 @@ import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
+import springfox.documentation.annotations.ApiIgnore;
 
 
 /**
@@ -15,6 +16,7 @@ import org.springframework.web.bind.annotation.*;
  * manage：是不需要登录的
  */
 //@CrossOrigin(origins = "*", maxAge = 3600)
+@ApiIgnore
 @Api(tags = "要素模块")
 @RequestMapping("manage/wfs")
 @RestController

src/main/java/com/fd/dto/ConfigJsonDto.java

@@ -1,5 +1,6 @@
 package com.fd.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -16,12 +17,14 @@ public class ConfigJsonDto {
     /**
      * 图层名称
      */
+    @ApiModelProperty(value = "图层名称", name = "text", required = true)
     private String text;
 
 
     /**
      * 图层角色
      */
+    @ApiModelProperty(value = "图层角色", name = "role", required = true)
     private String role;
 
 //    private boolean checked;

src/main/java/com/fd/dto/PageDto.java

@@ -1,5 +1,6 @@
 package com.fd.dto;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.Date;
@@ -11,12 +12,16 @@ import java.util.Date;
 @Data
 public class PageDto {
 
+    @ApiModelProperty(value = "当前页码", name = "pageNum")
     private Integer pageNum;
 
+    @ApiModelProperty(value = "每页数量", name = "pageSize")
     private Integer pageSize;
 
+    @ApiModelProperty(value = "开始日期", name = "startDate")
     private Date startDate;
 
+    @ApiModelProperty(value = "结束日期", name = "endDate")
     private Date endDate;
 
 

src/main/java/com/fd/dto/StyleDto.java

@@ -1,6 +1,7 @@
 package com.fd.dto;
 
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**