新增 solon.docs.openapi2 插件

noear · Jul 30, 2023 · c8fab5b · c8fab5b
1 parent 73cd50b
commit c8fab5b
Show file tree

Hide file tree

Showing 25 changed files with 1,557 additions and 124 deletions.
diff --git a/UPDATE_LOG.md b/UPDATE_LOG.md
@@ -14,6 +14,7 @@
 
 ### 2.4.2
 * 新增 lettuce-solon-plugin 插件
+* 新增 solon.docs.openapi2 插件
 * 新增 solon.cloud.metrics 插件?
 * 升级 solon-maven-plugin 的相关依赖
 * 增加 solon-admin-server 对 basic auth 配置的支持

diff --git a/__release/solon-base-bundle/pom.xml b/__release/solon-base-bundle/pom.xml
@@ -31,7 +31,7 @@
 
         <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.docs.openapi3</module>-->
 
         <module>../../solon-projects/solon-base/solon.auth</module>
         <module>../../solon-projects/solon-base/solon.test</module>

diff --git a/solon-parent/pom.xml b/solon-parent/pom.xml
@@ -55,7 +55,7 @@
         <snakeyaml.version>2.0</snakeyaml.version>
 
         <swagger.version>1.6.11</swagger.version>
-        <swagger2.version>2.2.15</swagger2.version>
+        <swagger2.version>2.1.13</swagger2.version>
         <knife4j.version>4.1.0</knife4j.version>
 
         <jackson.version>2.14.3</jackson.version>
@@ -409,11 +409,6 @@
                 <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/docs/openapi2/Swagger2Builder.java → .../solon/docs/openapi2/OpenApi2Builder.java b/.../solon/docs/openapi2/Swagger2Builder.java → .../solon/docs/openapi2/OpenApi2Builder.java
@@ -1,15 +1,16 @@
 package org.noear.solon.docs.openapi2;
 
 import io.swagger.annotations.*;
+import io.swagger.models.Contact;
 import io.swagger.models.ExternalDocs;
 import io.swagger.models.Info;
+import io.swagger.models.License;
 import io.swagger.models.Tag;
 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;
@@ -23,7 +24,12 @@
 import org.noear.solon.docs.ApiEnum;
 import org.noear.solon.docs.DocDocket;
 import org.noear.solon.docs.exception.DocException;
+import org.noear.solon.docs.models.ApiContact;
+import org.noear.solon.docs.models.ApiLicense;
 import org.noear.solon.docs.models.ApiScheme;
+import org.noear.solon.docs.openapi2.impl.ActionHolder;
+import org.noear.solon.docs.openapi2.impl.BuilderHelper;
+import org.noear.solon.docs.openapi2.impl.ParamHolder;
 
 import java.lang.reflect.*;
 import java.text.Collator;
@@ -35,7 +41,7 @@
  * @author noear
  * @since 2.3
  */
-public class Swagger2Builder {
+public class OpenApi2Builder {
     private final Swagger swagger = new Swagger();
     private final DocDocket docket;
 
@@ -44,7 +50,7 @@ public class Swagger2Builder {
      */
     private ModelImpl globalResultModel;
 
-    public Swagger2Builder(DocDocket docket) {
+    public OpenApi2Builder(DocDocket docket) {
         this.docket = docket;
     }
 
@@ -57,15 +63,34 @@ public Swagger build() {
         // 解析JSON
         this.parseGroupPackage();
 
+        ApiLicense apiLicense = docket.info().license();
+        ApiContact apiContact = docket.info().contact();
 
         swagger.setSwagger(docket.version());
         swagger.info(new Info()
                 .title(docket.info().title())
                 .description(docket.info().description())
                 .termsOfService(docket.info().termsOfService())
-                .version(docket.info().version())
-                .license(docket.info().license())
-                .contact(docket.info().contact()));
+                .version(docket.info().version()));
+
+        if (apiLicense != null) {
+            License license = new License()
+                    .url(apiLicense.url())
+                    .name(apiLicense.name());
+            license.setVendorExtensions(apiLicense.vendorExtensions());
+
+            swagger.getInfo().setLicense(license);
+        }
+
+        if (apiContact != null) {
+            Contact contact = new Contact()
+                    .email(apiContact.email())
+                    .name(apiContact.name())
+                    .url(apiContact.url());
+            contact.setVendorExtensions(apiContact.vendorExtensions());
+            swagger.getInfo().contact(contact);
+        }
+
 
         swagger.host(BuilderHelper.getHost(docket));
         swagger.basePath(docket.basePath());
@@ -81,7 +106,7 @@ public Swagger build() {
         }
 
         swagger.vendorExtensions(docket.vendorExtensions());
-        swagger.setSecurityDefinitions(docket.securityDefinitions());
+        //swagger.setSecurityDefinitions(docket.securityDefinitions());
 
         if (swagger.getTags() != null) {
             //排序
@@ -253,12 +278,12 @@ private void parseAction(List<ActionHolder> actionHolders) {
             operation.setDescription(apiAction.notes());
             operation.setDeprecated(actionHolder.isAnnotationPresent(Deprecated.class));
 
-            if ((actionHolder.isAnnotationPresent(ApiNoAuthorize.class) ||
-                    actionHolder.controllerClz().isAnnotationPresent(ApiNoAuthorize.class)) == false) {
-                for (String securityName : docket.securityDefinitions().keySet()) {
-                    operation.security(new SecurityRequirement(securityName).scope("global"));
-                }
-            }
+//            if ((actionHolder.isAnnotationPresent(ApiNoAuthorize.class) ||
+//                    actionHolder.controllerClz().isAnnotationPresent(ApiNoAuthorize.class)) == false) {
+//                for (String securityName : docket.securityDefinitions().keySet()) {
+//                    operation.security(new SecurityRequirement(securityName).scope("global"));
+//                }
+//            }
 
 
             String operationMethod = BuilderHelper.getHttpMethod(actionHolder, apiAction);

diff --git a/...n-base/solon.docs.openapi2/src/main/java/org/noear/solon/docs/openapi2/OpenApi2Utils.java b/...n-base/solon.docs.openapi2/src/main/java/org/noear/solon/docs/openapi2/OpenApi2Utils.java
@@ -59,7 +59,7 @@ public static String getApiJson(Context ctx, String group) throws IOException {
             docket.globalResponseCodes().put(200, "");
         }
 
-        Swagger swagger = new Swagger2Builder(docket).build();
+        Swagger swagger = new OpenApi2Builder(docket).build();
         return JsonUtil.toJson(swagger);
     }
 }
diff --git a/...ear/solon/docs/openapi2/ActionHolder.java → ...olon/docs/openapi2/impl/ActionHolder.java b/...ear/solon/docs/openapi2/ActionHolder.java → ...olon/docs/openapi2/impl/ActionHolder.java
@@ -1,4 +1,4 @@
-package org.noear.solon.docs.openapi2;
+package org.noear.solon.docs.openapi2.impl;
 
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;

diff --git a/...ar/solon/docs/openapi2/BuilderHelper.java → ...lon/docs/openapi2/impl/BuilderHelper.java b/...ar/solon/docs/openapi2/BuilderHelper.java → ...lon/docs/openapi2/impl/BuilderHelper.java
@@ -1,4 +1,4 @@
-package org.noear.solon.docs.openapi2;
+package org.noear.solon.docs.openapi2.impl;
 
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiOperation;

diff --git a/...oear/solon/docs/openapi2/ParamHolder.java → ...solon/docs/openapi2/impl/ParamHolder.java b/...oear/solon/docs/openapi2/ParamHolder.java → ...solon/docs/openapi2/impl/ParamHolder.java
@@ -1,4 +1,4 @@
-package org.noear.solon.docs.openapi2;
+package org.noear.solon.docs.openapi2.impl;
 
 import io.swagger.annotations.ApiImplicitParam;
 import org.noear.solon.Utils;

diff --git a/solon-projects/solon-base/solon.docs.openapi3/pom.xml b/solon-projects/solon-base/solon.docs.openapi3/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.openapi3</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.noear</groupId>
+            <artifactId>solon.docs</artifactId>
+        </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>
+    </dependencies>
+</project>