添加swagger注释

purchase-admin/pom.xml

@@ -24,19 +24,6 @@
             <optional>true</optional> <!-- 表示依赖不会传递 -->
         </dependency>
 
-        <!-- swagger3-->
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-boot-starter</artifactId>
-        </dependency>
-
-        <!-- 防止进入swagger页面报类型转换错误，排除3.0.0中的引用，手动增加1.6.2版本 -->
-        <dependency>
-            <groupId>io.swagger</groupId>
-            <artifactId>swagger-models</artifactId>
-            <version>1.6.2</version>
-        </dependency>
-
          <!-- Mysql驱动包 -->
         <dependency>
             <groupId>mysql</groupId>

purchase-admin/src/main/java/com/ozs/web/controller/system/SysConfigController.java

@@ -2,6 +2,10 @@ package com.ozs.web.controller.system;
 
 import java.util.List;
 import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
@@ -28,6 +32,7 @@ import com.ozs.system.service.ISysConfigService;
  *
  * @author ruoyi
  */
+@Api("信息操作处理")
 @RestController
 @RequestMapping("/system/config")
 public class SysConfigController extends BaseController
@@ -40,6 +45,7 @@ public class SysConfigController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:config:list')")
     @GetMapping("/list")
+    @ApiOperation("获取参数配置列表")
     public TableDataInfo list(SysConfig config)
     {
         startPage();
@@ -50,6 +56,7 @@ public class SysConfigController extends BaseController
     @Log(title = "参数管理", businessType = BusinessType.EXPORT)
     @PreAuthorize("@ss.hasPermi('system:config:export')")
     @PostMapping("/export")
+    @ApiOperation("参数导出")
     public void export(HttpServletResponse response, SysConfig config)
     {
         List<SysConfig> list = configService.selectConfigList(config);
@@ -62,6 +69,8 @@ public class SysConfigController extends BaseController
      */
     @PreAuthorize("@ss.hasPermi('system:config:query')")
     @GetMapping(value = "/{configId}")
+    @ApiOperation("根据参数编号获取详细信息")
+    @ApiImplicitParam(name = "configId", value = "参数ID", required = true, dataType = "Long", paramType = "path", dataTypeClass = Long.class)
     public AjaxResult getInfo(@PathVariable Long configId)
     {
         return success(configService.selectConfigById(configId));
@@ -71,6 +80,8 @@ public class SysConfigController extends BaseController
      * 根据参数键名查询参数值
      */
     @GetMapping(value = "/configKey/{configKey}")
+    @ApiOperation("根据参数键名查询参数值")
+    @ApiImplicitParam(name = "configKey", value = "参数键名", required = true, dataType = "String", paramType = "path", dataTypeClass = String.class)
     public AjaxResult getConfigKey(@PathVariable String configKey)
     {
         return success(configService.selectConfigByKey(configKey));
@@ -82,6 +93,7 @@ public class SysConfigController extends BaseController
     @PreAuthorize("@ss.hasPermi('system:config:add')")
     @Log(title = "参数管理", businessType = BusinessType.INSERT)
     @PostMapping
+    @ApiOperation("新增参数配置")
     public AjaxResult add(@Validated @RequestBody SysConfig config)
     {
         if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config)))
@@ -98,6 +110,7 @@ public class SysConfigController extends BaseController
     @PreAuthorize("@ss.hasPermi('system:config:edit')")
     @Log(title = "参数管理", businessType = BusinessType.UPDATE)
     @PutMapping
+    @ApiOperation("修改参数配置")
     public AjaxResult edit(@Validated @RequestBody SysConfig config)
     {
         if (UserConstants.NOT_UNIQUE.equals(configService.checkConfigKeyUnique(config)))
@@ -114,6 +127,8 @@ public class SysConfigController extends BaseController
     @PreAuthorize("@ss.hasPermi('system:config:remove')")
     @Log(title = "参数管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{configIds}")
+    @ApiOperation("删除参数配置")
+    @ApiImplicitParam(name = "configIds", value = "参数id集合", required = true, dataType = "Long[]", paramType = "path", dataTypeClass = Long.class)
     public AjaxResult remove(@PathVariable Long[] configIds)
     {
         configService.deleteConfigByIds(configIds);
@@ -126,6 +141,7 @@ public class SysConfigController extends BaseController
     @PreAuthorize("@ss.hasPermi('system:config:remove')")
     @Log(title = "参数管理", businessType = BusinessType.CLEAN)
     @DeleteMapping("/refreshCache")
+    @ApiOperation("刷新参数缓存")
     public AjaxResult refreshCache()
     {
         configService.resetConfigCache();

purchase-admin/src/main/resources/application.yml

@@ -9,8 +9,8 @@ purchase:
   # 实例演示开关
   demoEnabled: true
   # 文件路径 示例（ Windows配置D:/purchase/uploadPath，Linux配置 /home/purchase/uploadPath）
-  #  profile: C:/purchase/uploadPath
-  profile: /Users/sunhuanhuan/Documents/project/106/文档/purchase/uploadPath
+  profile: C:/purchase/uploadPath
+#  profile: /Users/sunhuanhuan/Documents/project/106/文档/purchase/uploadPath
   # 获取ip地址开关
   addressEnabled: false
   # 验证码类型 math 数组计算 char 字符验证
@@ -100,13 +100,13 @@ token:
     expireTime: 30
 
 # MyBatis配置
-mybatis:
-    # 搜索指定包别名
-    typeAliasesPackage: com.ozs.**.domain
-    # 配置mapper的扫描，找到所有的mapper.xml映射文件
-    mapperLocations: classpath*:mapper/**/*Mapper.xml
-    # 加载全局的配置文件
-    configLocation: classpath:mybatis/mybatis-config.xml
+#mybatis:
+#    # 搜索指定包别名
+#    typeAliasesPackage: com.ozs.**.domain
+#    # 配置mapper的扫描，找到所有的mapper.xml映射文件
+#    mapperLocations: classpath*:mapper/**/*Mapper.xml
+#    # 加载全局的配置文件
+#    configLocation: classpath:mybatis/mybatis-config.xml
 
 # MyBatis-plus配置
 mybatis-plus:

purchase-admin/src/main/resources/logback.xml

@@ -2,7 +2,7 @@
 <configuration>
     <!-- 日志存放路径 -->
 <!--	<property name="log.path" value="/home/ruoyi/logs" />-->
-    <property name="log.path" value="/Users/sunhuanhuan/Documents/project/106/文档/purchase/logs" />
+    <property name="log.path" value="C:/purchase/logs" />
     <!-- 日志输出格式 -->
 	<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />
 

purchase-common/pom.xml

@@ -175,6 +175,19 @@
 
         <!-- es  检索pdf word 内容依赖-->
 
+        <!-- swagger3-->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-boot-starter</artifactId>
+        </dependency>
+
+        <!-- 防止进入swagger页面报类型转换错误，排除3.0.0中的引用，手动增加1.6.2版本 -->
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-models</artifactId>
+            <version>1.6.2</version>
+        </dependency>
+
     </dependencies>
 
 </project>

purchase-common/src/main/java/com/ozs/common/core/domain/BaseEntity.java

@@ -7,39 +7,49 @@ import java.util.Map;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
  * Entity基类
  *
  * @author ruoyi
  */
+@ApiModel(value = "BaseEntity", description = "基础实体")
 public class BaseEntity implements Serializable
 {
     private static final long serialVersionUID = 1L;
 
     /** 搜索值 */
     @JsonIgnore
+    @ApiModelProperty("搜索值")
     private String searchValue;
 
     /** 创建者 */
+    @ApiModelProperty("创建者")
     private String createBy;
 
     /** 创建时间 */
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty("创建时间")
     private Date createTime;
 
     /** 更新者 */
+    @ApiModelProperty("更新者")
     private String updateBy;
 
     /** 更新时间 */
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    @ApiModelProperty("更新时间")
     private Date updateTime;
 
     /** 备注 */
+    @ApiModelProperty("备注")
     private String remark;
 
     /** 请求参数 */
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    @ApiModelProperty("请求参数")
     private Map<String, Object> params;
 
     public String getSearchValue()

purchase-system/src/main/java/com/ozs/system/domain/SysConfig.java

@@ -2,6 +2,9 @@ package com.ozs.system.domain;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 import com.ozs.common.annotation.Excel;
@@ -13,28 +16,34 @@ import com.ozs.common.core.domain.BaseEntity;
  *
  * @author ruoyi
  */
+@ApiModel(value = "SysConfig", description = "参数配置")
 public class SysConfig extends BaseEntity
 {
     private static final long serialVersionUID = 1L;
 
     /** 参数主键 */
     @Excel(name = "参数主键", cellType = ColumnType.NUMERIC)
+    @ApiModelProperty("参数主键")
     private Long configId;
 
     /** 参数名称 */
     @Excel(name = "参数名称")
+    @ApiModelProperty("参数名称")
     private String configName;
 
     /** 参数键名 */
     @Excel(name = "参数键名")
+    @ApiModelProperty("参数键名")
     private String configKey;
 
     /** 参数键值 */
     @Excel(name = "参数键值")
+    @ApiModelProperty("参数键值")
     private String configValue;
 
     /** 系统内置（Y是 N否） */
     @Excel(name = "系统内置", readConverterExp = "Y=是,N=否")
+    @ApiModelProperty("系统内置")
     private String configType;
 
     public Long getConfigId()