api文件添加响应参数

museum_common/src/main/java/com/museum/common/config/Swagger2.java

@@ -1,8 +1,11 @@
 package com.museum.common.config;
 
+import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
 import com.google.common.collect.Lists;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
@@ -29,6 +32,7 @@ import java.util.List;
  *
  * 2.9.2 不需要字启动类配置注解
  */
+//@EnableKnife4j 开启动态响应值
 @Configuration
 @EnableSwagger2
 public class Swagger2 {

museum_common/src/main/java/com/museum/common/util/Result.java

@@ -1,5 +1,6 @@
 package com.museum.common.util;
 
+import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -15,6 +16,7 @@ import java.io.Serializable;
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
+//@ApiModel("通用返回对象")
 public class Result<T> implements Serializable {
     private static final long serialVersionUID = -1491499610244557029L;
     public static final String SUCCESS_MSG = "操作成功";

museum_domain/src/main/java/com/museum/domain/entity/BaseEntity.java

@@ -2,6 +2,7 @@ package com.museum.domain.entity;
 
 import com.alibaba.fastjson.annotation.JSONField;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.persistence.*;
@@ -14,12 +15,15 @@ public abstract class BaseEntity {
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "id")
+    @ApiModelProperty(value = "对象ID")
     private Long id;
 
+    @ApiModelProperty(value = "创建时间")
     @Temporal(TemporalType.TIMESTAMP)
     @JSONField(format = "yyyy-MM-dd HH:mm:ss")
     private Date createTime;
 
+    @ApiModelProperty(value = "修改时间")
     @Temporal(TemporalType.TIMESTAMP)
     @JSONField(format = "yyyy-MM-dd HH:mm:ss")
     private Date updateTime;

museum_domain/src/main/java/com/museum/domain/entity/PartEntity.java

@@ -1,5 +1,8 @@
 package com.museum.domain.entity;
 
+import com.alibaba.fastjson.annotation.JSONField;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.persistence.Table;
@@ -10,41 +13,41 @@ import java.io.Serializable;
  */
 @Data
 @Table(name = "tb_part")
+//@ApiModel("部件对象")
 public class PartEntity extends BaseEntity implements Serializable {
 
     private static final long serialVersionUID = -5191918181588231778L;
 
-    /** 名称 */
+//    @ApiModelProperty(notes = "用户名", example = "123", required = true)
+    @ApiModelProperty(value = "名称")
     private String name;
 
-    /** 楼体 */
+    @ApiModelProperty(value = "楼体， 1：东楼，2：西楼")
     private Integer block;
 
-    /** 区域 */
+    @ApiModelProperty(value = "区域, in:室内，out:室外")
     private String zone;
 
-//    /** 模型类型 */
-//    private String modelType;
-
-    /** 展示内容  */
+    @ApiModelProperty(value = "展示内容")
     private String content;
 
-    /** 场景rul  */
+    @ApiModelProperty(value = "场景rul")
     private String webSite;
 
-    /** 程序显示， 0：显示，1：不显示  */
+    @ApiModelProperty(value = "程序显示， 0：显示，1：不显示")
     private Integer display;
 
-    /** 图标，base64  */
+    @ApiModelProperty(value = "图标，base64")
     private String ico;
 
-    /** 材质  */
+    @ApiModelProperty(value = "材质")
     private String material;
 
-    /** 展示类型  */
+    @ApiModelProperty(value = "展示类型id")
     private Long typeId;
 
-    /** 文件目录  */
+    @JSONField(serialize = false)
+    @ApiModelProperty(value = "文件目录")
     private String fileDir;
 
 

museum_domain/src/main/java/com/museum/domain/entity/RoamEntity.java

@@ -1,5 +1,6 @@
 package com.museum.domain.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.persistence.Table;
@@ -14,28 +15,25 @@ public class RoamEntity extends BaseEntity implements Serializable {
 
     private static final long serialVersionUID = -5191918181588231778L;
 
-    /** 名称 */
+    @ApiModelProperty(value = "名称")
     private String name;
 
-    /** 楼体 */
+    @ApiModelProperty(value = "楼体， 1：东楼，2：西楼")
     private Integer block;
 
-    /** 区域 */
+    @ApiModelProperty(value = "区域, in:室内，out:室外")
     private String zone;
 
-//    /** 模型类型 */
-//    private String modelType;
-
-    /** 展示内容  */
+    @ApiModelProperty(value = "展示内容")
     private String content;
 
-    /** 场景rul  */
+    @ApiModelProperty(value = "场景rul")
     private String webSite;
 
-    /** 程序显示， 0：显示，1：不显示  */
+    @ApiModelProperty(value = "程序显示， 0：显示，1：不显示")
     private Integer display;
 
-    /** 展示类型  */
+    @ApiModelProperty(value = "展示类型id")
     private Long typeId;
 
 

museum_domain/src/main/java/com/museum/domain/entity/TypeEntity.java

@@ -1,5 +1,6 @@
 package com.museum.domain.entity;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import javax.persistence.Table;
@@ -15,10 +16,10 @@ public class TypeEntity extends BaseEntity implements Serializable {
     private static final long serialVersionUID = -5191918181588231778L;
 
 
-    /** 模型类型 */
+    @ApiModelProperty(value = "模型类型, part:部件，roam:漫游")
     private String modelType;
 
-    /** 展示类型  */
+    @ApiModelProperty(value = "展示类型")
     private String name;
 
 

museum_domain/src/main/java/com/museum/domain/request/BuildingRequest.java

@@ -30,7 +30,6 @@ public class BuildingRequest implements Serializable {
     @ApiModelProperty(value = "模型链接", name = "webSite", required = true)
     private String webSite;
 
-//    @NotNull(message = "展示封面不能为空")
     @ApiModelProperty(value = "展示封面， 以base64传输", name = "ico")
     private String ico;
 

museum_domain/src/main/java/com/museum/domain/request/PartRequest.java

@@ -17,7 +17,9 @@ public class PartRequest  {
     private Long id;
 
     @NotNull(message = "名称不能为空")
-    @ApiModelProperty(value = "名称", name = "name", required = true)
+//    @ApiModelProperty(value = "名称", name = "name", required = true)
+    @ApiModelProperty(value = "名称", required = true)
+//    @ApiModelProperty(notes = "用户名", example = "123", required = true)
     private String name;
 
     @NotNull(message = "楼体不能为空")

museum_web/src/main/java/com/museum/web/controller/CommonController.java

@@ -36,7 +36,7 @@ public class CommonController extends BaseController {
     })
     @ApiOperation("获取导航")
     @GetMapping("nav/{modelType}")
-    public Result nav(@PathVariable String modelType) {
+    public Result<TypeEntity> nav(@PathVariable String modelType) {
         Condition condition = new Condition(TypeEntity.class);
         condition.and().andEqualTo("modelType", modelType);
         List<TypeEntity> list = typeService.findAll(condition);

museum_web/src/main/java/com/museum/web/controller/DownloadController.java

@@ -134,24 +134,4 @@ public class DownloadController extends BaseController {
 
 
 
-
-//    @ApiImplicitParams({
-//            @ApiImplicitParam(name = "modelType", value = "模型类型, roam:自由漫游，part：部件欣赏", required = true)
-//    })
-//    @ApiOperation("获取导航")
-//    @GetMapping("nav/{modelType}")
-//    public Result nav(@PathVariable String modelType) {
-//        Condition condition = new Condition(TypeEntity.class);
-//        condition.and().andEqualTo("modelType", modelType);
-//        List<TypeEntity> list = typeService.findAll(condition);
-//        return Result.success(list);
-//    }
-
-
-
-
-
-
-
-
 }

museum_web/src/main/java/com/museum/web/controller/PartController.java

@@ -19,7 +19,6 @@ import lombok.extern.log4j.Log4j2;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.BeanUtils;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.*;
 
@@ -43,16 +42,11 @@ public class PartController extends BaseController {
     @Autowired
     public PartService partService;
 
-//    @Autowired
-//    public FileService fileService;
-
-//    @Value("${output.file.path}")
-//    private String OUT_PATH;
 
 
     @ApiOperation("列表/条件筛选")
     @PostMapping("list")
-    public Result list(@Valid @RequestBody NavRequest param) {
+    public Result<PartEntity> list(@Valid @RequestBody NavRequest param) {
         startPage(param);
         PageInfo<PartEntity> page = new PageInfo<>(partService.findByNav(param));
         return Result.success(page);
@@ -146,4 +140,13 @@ public class PartController extends BaseController {
         return Result.success();
     }
 
+
+    @ApiOperation("测试")
+    @PostMapping("test")
+    public Result test(@RequestBody PartEntity param ) {
+
+
+        return Result.success(param);
+    }
+
 }

museum_web/src/main/java/com/museum/web/controller/RoamController.java

@@ -38,7 +38,7 @@ public class RoamController extends BaseController {
 
     @ApiOperation("列表/条件筛选")
     @PostMapping("list")
-    public Result list(@Valid @RequestBody NavRequest param) {
+    public Result<RoamEntity> list(@Valid @RequestBody NavRequest param) {
         startPage(param);
         PageInfo<RoamEntity> page = new PageInfo<>(roamService.findByNav(param));
         return Result.success(page);
@@ -74,7 +74,7 @@ public class RoamController extends BaseController {
 
     @ApiOperation("详情")
     @GetMapping("detail/{id}")
-    public Result detail(@PathVariable Long id) {
+    public Result<RoamEntity> detail(@PathVariable Long id) {
         RoamEntity entity = roamService.findById(id);
 
         if (entity == null) {