add API Docs

Author: qdriven

docs/qaworkspace/project/README.md

@@ -0,0 +1,81 @@
+package io.fluentqa.pm.project.model;
+
+
+import io.fluentqa.erupts.base.model.ModelWithValidFlagVo;
+import io.fluentqa.pm.product.model.Product;
+import lombok.Data;
+import xyz.erupt.annotation.Erupt;
+import xyz.erupt.annotation.EruptField;
+import xyz.erupt.annotation.sub_erupt.Power;
+import xyz.erupt.annotation.sub_erupt.Tree;
+import xyz.erupt.annotation.sub_field.Edit;
+import xyz.erupt.annotation.sub_field.EditType;
+import xyz.erupt.annotation.sub_field.View;
+import xyz.erupt.annotation.sub_field.sub_edit.ChoiceType;
+import xyz.erupt.annotation.sub_field.sub_edit.InputType;
+import xyz.erupt.annotation.sub_field.sub_edit.ReferenceTreeType;
+import xyz.erupt.annotation.sub_field.sub_edit.Search;
+import xyz.erupt.toolkit.handler.SqlChoiceFetchHandler;
+
+import javax.persistence.*;
+import java.util.UUID;
+
+@Erupt(name = "项目配置",
+        power = @Power(importable = true, export = true),
+        tree = @Tree(pid = "parent.id"))
+@Entity
+@Table(name = "projects")
+@Data
+public class Project extends ModelWithValidFlagVo {
+
+    @EruptField(
+            views = @View(
+                    title = "名称"
+            ),
+            edit = @Edit(
+                    title = "名称",
+                    type = EditType.INPUT, search = @Search,
+                    notNull = true,
+                    inputType = @InputType
+            )
+    )
+    private String name;
+
+    @EruptField(
+            views = @View(
+                    title = "代号"
+            ),
+            edit = @Edit(
+                    title = "代号",
+                    type = EditType.INPUT, search = @Search,
+                    notNull = true,
+                    inputType = @InputType
+            )
+    )
+    private String code;
+
+    @EruptField(
+            views = @View(
+                    title = "详细描述"
+            ),
+            edit = @Edit(
+                    title = "详细描述",
+                    type = EditType.INPUT, search = @Search, notNull = true,
+                    inputType = @InputType
+            )
+    )
+    private String details;
+
+    @ManyToOne
+    @EruptField(
+            edit = @Edit(
+                    title = "产品清单",
+                    type = EditType.REFERENCE_TREE,
+                    referenceTreeType = @ReferenceTreeType(pid = "parent.id")
+            )
+    )
+    private Product productId;
+
+    @Column(length = 36, nullable = false, updatable = false)
+    private String uuid = UUID.randomUUID().toString();
+}

fluent-erupts/fluent-pm/src/main/java/io/fluentqa/pm/project/model/Project.java

@@ -51,6 +51,11 @@
             <artifactId>fluent-pm</artifactId>
             <version>${fluent.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
+            <version>4.3.0</version>
+        </dependency>
 
     </dependencies>
     <build>

server/pom.xml

@@ -39,6 +39,38 @@ spring:
       max-file-size: 100MB
       max-request-size: 100MB
 
+# springdoc-openapi项目配置
+springdoc:
+  swagger-ui:
+    path: /swagger-ui.html
+    tags-sorter: alpha
+    operations-sorter: alpha
+  api-docs:
+    path: /v3/api-docs
+  group-configs:
+    - group: 'default'
+      paths-to-match: '/**'
+      packages-to-scan: com.xiaominfo.knife4j.demo.web
+# knife4j的增强配置，不需要增强可以不配
+knife4j:
+  enable: true
+  openapi:
+    title: Knife4j官方文档
+    description: "`我是测试`,**你知道吗**
+    # aaa"
+    email: [email protected]
+    concat: 八一菜刀
+    url: https://docs.xiaominfo.com
+    version: v4.0
+    license: Apache 2.0
+    license-url: https://stackoverflow.com/
+    terms-of-service-url: https://stackoverflow.com/
+    group:
+      test1:
+        group-name: 分组名称
+        api-rule: package
+#        api-rule-resources:
+#          - com.knife4j.demo.new3
 
 server:
   # 启用 gzip 压缩