feature: 增加 swagger 注解

Author: myoss

pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>app.myoss.cloud</groupId>
         <artifactId>myoss-spring-boot-parent</artifactId>
-        <version>2020.0.0.RELEASE</version>
+        <version>2021.0.0.RELEASE</version>
     </parent>
 
     <groupId>app.myoss.cloud.mybatis</groupId>
@@ -116,5 +116,11 @@
             <scope>test</scope>
         </dependency>
         <!-- test end -->
+
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 </project>

src/main/java/app/myoss/cloud/mybatis/repository/entity/AuditEntity.java

@@ -31,6 +31,7 @@
  * @author Jerry.Chen
  * @since 2018年5月9日 下午2:10:02
  */
+@io.swagger.annotations.ApiModel("审计实体基类，包含审计的字段")
 @Accessors(chain = true)
 @EqualsAndHashCode(callSuper = true)
 @Data
@@ -47,6 +48,7 @@ public class AuditEntity extends LogicDeleteEntity {
      * Database Column Remarks: 创建者
      * </p>
      */
+    @io.swagger.annotations.ApiModelProperty("创建者")
     @com.alibaba.fastjson.annotation.JSONField(label = LABEL_AUDIT_ENTITY)
     @Column(name = "creator", nullable = false, fillRule = { FillRule.INSERT })
     private String             creator;
@@ -57,6 +59,7 @@ public class AuditEntity extends LogicDeleteEntity {
      * Database Column Remarks: 修改者
      * </p>
      */
+    @io.swagger.annotations.ApiModelProperty("修改者")
     @com.alibaba.fastjson.annotation.JSONField(label = LABEL_AUDIT_ENTITY)
     @Column(name = "modifier", nullable = false, fillRule = { FillRule.INSERT, FillRule.UPDATE })
     private String             modifier;
@@ -67,6 +70,7 @@ public class AuditEntity extends LogicDeleteEntity {
      * Database Column Remarks: 创建时间
      * </p>
      */
+    @io.swagger.annotations.ApiModelProperty("创建时间")
     @com.alibaba.fastjson.annotation.JSONField(label = LABEL_AUDIT_ENTITY)
     @Column(name = "gmt_created", nullable = false, fillRule = { FillRule.INSERT })
     private Date               gmtCreated;
@@ -77,6 +81,7 @@ public class AuditEntity extends LogicDeleteEntity {
      * Database Column Remarks: 修改时间
      * </p>
      */
+    @io.swagger.annotations.ApiModelProperty("修改时间")
     @com.alibaba.fastjson.annotation.JSONField(label = LABEL_AUDIT_ENTITY)
     @Column(name = "gmt_modified", nullable = false, fillRule = { FillRule.INSERT, FillRule.UPDATE })
     private Date               gmtModified;

src/main/java/app/myoss/cloud/mybatis/repository/entity/AuditIdEntity.java

@@ -31,6 +31,7 @@
  * @author Jerry.Chen
  * @since 2018年5月9日 下午2:15:14
  */
+@io.swagger.annotations.ApiModel("审计实体基类，包含审计的字段，增加了主键id字段")
 @Accessors(chain = true)
 @EqualsAndHashCode(callSuper = true)
 @Data
@@ -46,6 +47,7 @@ public class AuditIdEntity<I extends Serializable> extends AuditEntity implement
      * <p>
      * Database Column Remarks: 主键id
      */
+    @io.swagger.annotations.ApiModelProperty("主键id")
     @Column(primaryKey = true)
     private I                  id;
 

src/main/java/app/myoss/cloud/mybatis/repository/entity/LogicDeleteEntity.java

@@ -29,6 +29,7 @@
  * @author Jerry.Chen
  * @since 2018年5月9日 下午2:20:26
  */
+@io.swagger.annotations.ApiModel("逻辑删除实体基类")
 @Accessors(chain = true)
 @Data
 public class LogicDeleteEntity implements BaseEntity {
@@ -44,6 +45,7 @@ public class LogicDeleteEntity implements BaseEntity {
      * Database Column Remarks: 是否删除
      * </p>
      */
+    @io.swagger.annotations.ApiModelProperty("是否删除")
     @com.alibaba.fastjson.annotation.JSONField(label = LABEL_LOGIC_DELETE_ENTITY)
     @Column(name = "is_deleted", nullable = false, fillRule = {
             FillRule.INSERT }, logicDelete = true, logicDeleteValue = MyossConstants.Y, logicUnDeleteValue = MyossConstants.N)