Explorar o código

api文件添加响应参数

wuweihao %!s(int64=5) %!d(string=hai) anos
pai
achega
c390448103

+ 1 - 1
museum_domain/src/main/java/com/museum/domain/entity/PartEntity.java

@@ -22,7 +22,7 @@ public class PartEntity extends BaseEntity implements Serializable {
     @ApiModelProperty(value = "名称")
     private String name;
 
-    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼")
+    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼,3:钟楼")
     private Integer block;
 
     @ApiModelProperty(value = "区域, in:室内,out:室外")

+ 1 - 1
museum_domain/src/main/java/com/museum/domain/entity/RoamEntity.java

@@ -18,7 +18,7 @@ public class RoamEntity extends BaseEntity implements Serializable {
     @ApiModelProperty(value = "名称")
     private String name;
 
-    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼")
+    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼,3:钟楼")
     private Integer block;
 
     @ApiModelProperty(value = "区域, in:室内,out:室外")

+ 1 - 1
museum_domain/src/main/java/com/museum/domain/request/BuildingRequest.java

@@ -15,7 +15,7 @@ public class BuildingRequest implements Serializable {
 
     private static final long serialVersionUID = -519197184688236778L;
 
-    @ApiModelProperty(value = "id,修改时必须传,新增忽略", name = "id")
+    @ApiModelProperty(value = "id, 修改时必须传,新增忽略", name = "id")
     private Long id;
 
     @NotNull(message = "建筑物名称不能为空")

+ 0 - 4
museum_domain/src/main/java/com/museum/domain/request/MessageRequest.java

@@ -14,19 +14,15 @@ public class MessageRequest implements Serializable {
     private static final long serialVersionUID = -5191918184588231778L;
 
 
-    /** 游客名称 */
     @ApiModelProperty(value = "游客名称", name = "userName", required = true)
     private String userName;
 
-    /** 电话 */
     @ApiModelProperty(value = "电话", name = "phone")
     private String phone;
 
-    /** 邮箱 */
     @ApiModelProperty(value = "邮箱", name = "email")
     private String email;
 
-    /** 留言  */
     @ApiModelProperty(value = "留言", name = "message", required = true)
     private String message;
 }

+ 3 - 10
museum_domain/src/main/java/com/museum/domain/request/NavRequest.java

@@ -14,20 +14,13 @@ public class NavRequest extends PageRequest implements Serializable {
     private static final long serialVersionUID = -5182918184588231778L;
 
 
-    /** 楼体 */
-    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼", name = "block")
+    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼,3:钟楼")
     private Integer block;
 
-    /** 区域 */
-    @ApiModelProperty(value = "区域, in:室内,out:室外", name = "zone")
+    @ApiModelProperty(value = "区域, in:室内,out:室外")
     private String zone;
 
-//    /** 模型类型 */
-//    @ApiModelProperty(value = "模型类型, roam:自由漫游,part:部件欣赏", name = "modelType")
-//    private String modelType;
-
-    /** 组件类型id  */
-    @ApiModelProperty(value = "组件类型id", name = "typeId")
+    @ApiModelProperty(value = "组件类型id")
     private Long typeId;
 
 }

+ 1 - 1
museum_domain/src/main/java/com/museum/domain/request/PartRequest.java

@@ -23,7 +23,7 @@ public class PartRequest  {
     private String name;
 
     @NotNull(message = "楼体不能为空")
-    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼", name = "block", required = true)
+    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼,3:钟楼", required = true)
     private Integer block;
 
     @NotNull(message = "区域不能为空")

+ 1 - 5
museum_domain/src/main/java/com/museum/domain/request/RoamRequest.java

@@ -22,17 +22,13 @@ public class RoamRequest implements Serializable {
     private String name;
 
     @NotNull(message = "楼体不能为空")
-    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼", name = "block", required = true)
+    @ApiModelProperty(value = "楼体, 1:东楼,2:西楼,3:钟楼", required = true)
     private Integer block;
 
     @NotNull(message = "区域不能为空")
     @ApiModelProperty(value = "区域, in:室内,out:室外", name = "zone", required = true)
     private String zone;
 
-//    @NotNull(message = "模型类型不能为空")
-//    @ApiModelProperty(value = "模型类型, roam:自由漫游,part:部件欣赏", name = "modelType")
-//    private String modelType;
-
     @NotNull(message = "类型id不能为空")
     @ApiModelProperty(value = "类型id", name = "typeId", required = true)
     private Long typeId;

+ 1 - 1
museum_domain/src/main/java/com/museum/domain/request/UserRequest.java

@@ -27,7 +27,7 @@ public class UserRequest implements Serializable {
 
     @NotNull(message = "状态不能为空")
     @ApiModelProperty(value = "状态, 0:启用  1:停用 2:注销", name = "status", required = true)
-    private Integer status; // 0:启用  1:停用 2:注销
+    private Integer status;
 
     @NotNull(message = "角色不能为空")
     @ApiModelProperty(value = "角色:只有两种 admin normal", name = "role", required = true)

+ 6 - 6
museum_domain/src/main/java/com/museum/domain/response/DownloadResponse.java

@@ -12,22 +12,22 @@ public class DownloadResponse extends BaseEntity {
 
     private Long id;
 
-    /** 模块类型 */
+    @ApiModelProperty(value = "模块类型,part:部件, building:建筑物")
     private String type;
 
-    @ApiModelProperty(value = "组件名称", name = "name")
+    @ApiModelProperty(value = "组件名称")
     private String name;
 
-    /** 申请原因 */
+    @ApiModelProperty(value = "申请原因")
     private String reason;
 
-    /** 状态  */
+    @ApiModelProperty(value = "状态,1:申请中,2:同意,3:驳回")
     private Integer status;
 
-    /** 申请人 */
+    @ApiModelProperty(value = "申请人")
     private String userName;
 
-    /** 文件id  */
+    @ApiModelProperty(value = "文件id")
     private String fileIds;
 
 }

+ 4 - 4
museum_domain/src/main/java/com/museum/domain/response/LogResponse.java

@@ -1,6 +1,7 @@
 package com.museum.domain.response;
 
 import com.museum.domain.entity.BaseEntity;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,14 +11,13 @@ import lombok.Data;
 public class LogResponse extends BaseEntity {
 
 
-    /** 操作者账号 */
+    @ApiModelProperty(value = "操作者账号")
     private String userName;
 
-    /** 操作类型 */
+    @ApiModelProperty(value = "操作类型")
     private String type;
 
-
-    /** 操作记录 */
+    @ApiModelProperty(value = "操作记录")
     private String description;
 
 //    /** 操作状态,0:成功, 1:失败 */

+ 2 - 19
museum_web/src/main/java/com/museum/web/controller/BuildingController.java

@@ -42,19 +42,13 @@ import java.util.Map;
 public class BuildingController extends BaseController {
 
     @Autowired
-    public BuildingService buildingService;
-
-    @Autowired
-    public FileService fileService;
-
-    @Value("${output.file.path}")
-    private String OUT_PATH;
+    private BuildingService buildingService;
 
 
 //    @RequiresRoles(value = {"admin"}, logical = Logical.OR)
     @ApiOperation("列表")
     @PostMapping("list")
-    public Result list(@RequestBody PageRequest param) {
+    public Result<BuildingEntity> list(@RequestBody PageRequest param) {
         startPage(param);
         PageInfo<BuildingEntity> page = new PageInfo<>(buildingService.findAll());
         return Result.success(page);
@@ -119,15 +113,4 @@ public class BuildingController extends BaseController {
     }
 
 
-//    @ApiOperation("123")
-//    @PostMapping("123")
-//    public Result detail123(BuildingRequest param) {
-//
-////        @NotNull(message = "建筑物名称不能为空") String name = param.getName();
-////        @NotNull(message = "建筑物描述不能为空") String description = param.getDescription();
-//
-//        return Result.success();
-//    }
-
-
 }

+ 3 - 7
museum_web/src/main/java/com/museum/web/controller/DownloadController.java

@@ -42,19 +42,15 @@ import java.util.List;
 public class DownloadController extends BaseController {
 
     @Autowired
-    public DownloadService downloadService;
+    private DownloadService downloadService;
 
     @Autowired
-    public UserService userService;
-
-    @Autowired
-    public FileService fileService;
-
+    private UserService userService;
 
 
     @ApiOperation("列表")
     @PostMapping("list")
-    public Result list(@Valid @RequestBody PageRequest param) {
+    public Result<DownloadResponse> list(@Valid @RequestBody PageRequest param) {
         startPage(param);
         Long userId = getTokenUserId();
         String userRole = getTokenUserRole();

+ 1 - 1
museum_web/src/main/java/com/museum/web/controller/LogController.java

@@ -42,7 +42,7 @@ public class LogController extends BaseController {
 
     @ApiOperation("列表")
     @PostMapping("list")
-    public Result list(@RequestBody PageRequest param) {
+    public Result<LogResponse> list(@RequestBody PageRequest param) {
         startPage(param);
         PageInfo<LogResponse> page = new PageInfo<>(logService.search(param));
         return Result.success(page);

+ 0 - 8
museum_web/src/main/java/com/museum/web/controller/PartController.java

@@ -141,12 +141,4 @@ public class PartController extends BaseController {
     }
 
 
-    @ApiOperation("测试")
-    @PostMapping("test")
-    public Result test(@RequestBody PartEntity param ) {
-
-
-        return Result.success(param);
-    }
-
 }

+ 0 - 3
museum_web/src/main/java/com/museum/web/controller/UserController.java

@@ -46,8 +46,6 @@ public class UserController extends BaseController {
 
 
 
-//        @RequiresRoles("admin")
-//    @WebControllerLog(description = "用户管理-用户列表")
     @RequiresRoles(value = {"admin"}, logical = Logical.OR)
     @ApiOperation("用户列表")
     @PostMapping("list")
@@ -125,7 +123,6 @@ public class UserController extends BaseController {
     @ApiOperation("重置密码")
     @GetMapping("resetPass/{id}")
     public Result resetPass(@PathVariable Long id) {
-        log.warn(111111111);
         UserEntity user = userService.findById(id);
 
         if (user == null) {