添加 solon.docs.openapi2 插件

opensolon · Jul 30, 2023 · 73cd50b · 73cd50b
1 parent 8ad0dfa
commit 73cd50b
Show file tree

Hide file tree

Showing 14 changed files with 112 additions and 19 deletions.
diff --git a/__release/solon-base-bundle/pom.xml b/__release/solon-base-bundle/pom.xml
@@ -30,6 +30,9 @@
         <module>../../solon-projects/solon-base/solon.data.shardingds</module>
 
         <module>../../solon-projects/solon-base/solon.docs</module>
+        <module>../../solon-projects/solon-base/solon.docs.openapi2</module>
+        <module>../../solon-projects/solon-base/solon.docs.openapi3</module>
+
         <module>../../solon-projects/solon-base/solon.auth</module>
         <module>../../solon-projects/solon-base/solon.test</module>
         <module>../../solon-projects/solon-base/solon.validation</module>

diff --git a/solon-parent/pom.xml b/solon-parent/pom.xml
@@ -55,6 +55,7 @@
         <snakeyaml.version>2.0</snakeyaml.version>
 
         <swagger.version>1.6.11</swagger.version>
+        <swagger2.version>2.2.15</swagger2.version>
         <knife4j.version>4.1.0</knife4j.version>
 
         <jackson.version>2.14.3</jackson.version>
@@ -403,6 +404,16 @@
                 <artifactId>solon.docs</artifactId>
                 <version>${solon.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.noear</groupId>
+                <artifactId>solon.docs.openapi2</artifactId>
+                <version>${solon.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.noear</groupId>
+                <artifactId>solon.docs.openapi3</artifactId>
+                <version>${solon.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.noear</groupId>
                 <artifactId>solon.auth</artifactId>

diff --git a/solon-projects/solon-base/solon.docs.openapi2/pom.xml b/solon-projects/solon-base/solon.docs.openapi2/pom.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.noear</groupId>
+        <artifactId>solon-parent</artifactId>
+        <version>2.4.2-SNAPSHOT</version>
+        <relativePath>../../../solon-parent/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>solon.docs.openapi2</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.noear</groupId>
+            <artifactId>solon.docs</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <version>${swagger.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.swagger</groupId>
+            <artifactId>swagger-models</artifactId>
+            <version>${swagger.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-annotations</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/...ear/solon/docs/openapi2/ActionHolder.java → ...ear/solon/docs/openapi2/ActionHolder.java b/...ear/solon/docs/openapi2/ActionHolder.java → ...ear/solon/docs/openapi2/ActionHolder.java
diff --git a/...ar/solon/docs/openapi2/BuilderHelper.java → ...ar/solon/docs/openapi2/BuilderHelper.java b/...ar/solon/docs/openapi2/BuilderHelper.java → ...ar/solon/docs/openapi2/BuilderHelper.java
diff --git a/...ar/solon/docs/openapi2/OpenApi2Utils.java → ...ar/solon/docs/openapi2/OpenApi2Utils.java b/...ar/solon/docs/openapi2/OpenApi2Utils.java → ...ar/solon/docs/openapi2/OpenApi2Utils.java
diff --git a/...oear/solon/docs/openapi2/ParamHolder.java → ...oear/solon/docs/openapi2/ParamHolder.java b/...oear/solon/docs/openapi2/ParamHolder.java → ...oear/solon/docs/openapi2/ParamHolder.java
diff --git a/.../solon/docs/openapi2/Swagger2Builder.java → .../solon/docs/openapi2/Swagger2Builder.java b/.../solon/docs/openapi2/Swagger2Builder.java → .../solon/docs/openapi2/Swagger2Builder.java
@@ -1,25 +1,22 @@
 package org.noear.solon.docs.openapi2;
 
 import io.swagger.annotations.*;
-import io.swagger.models.*;
 import io.swagger.models.ExternalDocs;
 import io.swagger.models.Info;
 import io.swagger.models.Tag;
-import io.swagger.models.parameters.*;
+import io.swagger.models.*;
 import io.swagger.models.parameters.Parameter;
+import io.swagger.models.parameters.*;
 import io.swagger.models.properties.*;
 import io.swagger.models.refs.RefFormat;
-
 import io.swagger.solon.annotation.ApiNoAuthorize;
 import io.swagger.solon.annotation.ApiRes;
 import io.swagger.solon.annotation.ApiResProperty;
-
 import org.noear.solon.Solon;
 import org.noear.solon.Utils;
 import org.noear.solon.core.handle.*;
 import org.noear.solon.core.route.Routing;
 import org.noear.solon.core.util.GenericUtil;
-
 import org.noear.solon.core.wrap.ClassWrap;
 import org.noear.solon.core.wrap.FieldWrap;
 import org.noear.solon.core.wrap.ParamWrap;

diff --git a/solon-projects/solon-base/solon.docs/pom.xml b/solon-projects/solon-base/solon.docs/pom.xml
@@ -42,6 +42,28 @@
             </exclusions>
         </dependency>
 
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <version>${swagger2.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-models</artifactId>
+            <version>${swagger2.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-annotations</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>

diff --git a/solon-projects/solon-base/solon.docs/src/main/java/org/noear/solon/docs/DocDocket.java b/solon-projects/solon-base/solon.docs/src/main/java/org/noear/solon/docs/DocDocket.java
@@ -46,6 +46,10 @@ public class DocDocket {
     private Map<String, Object> vendorExtensions = new LinkedHashMap<>();
 
 
+    public DocDocket(DocType docType) {
+        this.version = docType.getVersion();
+    }
+
     public String version() {
         return version;
     }

diff --git a/solon-projects/solon-base/solon.docs/src/main/java/org/noear/solon/docs/DocType.java b/solon-projects/solon-base/solon.docs/src/main/java/org/noear/solon/docs/DocType.java
@@ -0,0 +1,20 @@
+package org.noear.solon.docs;
+
+/**
+ * @author noear
+ * @since 2.4
+ */
+public enum DocType {
+    SWAGGER_2("2.0"),
+    SWAGGER_3("3.0");
+
+    String version;
+
+    DocType(String version) {
+        this.version = version;
+    }
+
+    public String getVersion() {
+        return version;
+    }
+}
diff --git a/...ts/solon-base/solon.docs/src/main/java/org/noear/solon/docs/openapi3/Swagger3Builder.java b/...ts/solon-base/solon.docs/src/main/java/org/noear/solon/docs/openapi3/Swagger3Builder.java
diff --git a/solon-projects/solon-tool/solon-openapi2-knife4j/pom.xml b/solon-projects/solon-tool/solon-openapi2-knife4j/pom.xml
@@ -17,7 +17,7 @@
     <dependencies>
         <dependency>
             <groupId>org.noear</groupId>
-            <artifactId>solon.docs</artifactId>
+            <artifactId>solon.docs.openapi2</artifactId>
         </dependency>
 
         <dependency>

diff --git a/solon-projects/solon-tool/solon-openapi2-knife4j/src/test/java/com/swagger/demo/Config.java b/solon-projects/solon-tool/solon-openapi2-knife4j/src/test/java/com/swagger/demo/Config.java
@@ -4,6 +4,7 @@
 import com.swagger.demo.model.HttpCodes;
 
 import org.noear.solon.docs.ApiEnum;
+import org.noear.solon.docs.DocType;
 import org.noear.solon.docs.models.ApiInfo;
 import org.noear.solon.docs.DocDocket;
 
@@ -36,7 +37,7 @@ public DocDocket adminApi(@Inject("${swagger.adminApi}") DocDocket docket) {
      */
     @Bean("appApi")
     public DocDocket appApi() {
-        return new DocDocket()
+        return new DocDocket(DocType.SWAGGER_2)
                 .groupName("app端接口")
                 .schemes(ApiEnum.SCHEMES_HTTP)
                 .globalResult(Result.class)
@@ -51,7 +52,7 @@ public DocDocket appApi() {
      */
     @Bean("gatewayApi")
     public DocDocket gatewayApi() {
-        return new DocDocket()
+        return new DocDocket(DocType.SWAGGER_2)
                 .groupName("gateway端接口")
                 .schemes(ApiEnum.SCHEMES_HTTP)
                 .globalResult(Result.class)
@@ -63,7 +64,7 @@ public DocDocket gatewayApi() {
 
     //    @Bean("appApi")
     public DocDocket appApi2() {
-        return new DocDocket()
+        return new DocDocket(DocType.SWAGGER_2)
                 .groupName("app端接口")
                 .info(new ApiInfo().title("在线文档")
                         .description("在线API文档")