feat($Swagger): beautify Swagger UI by Knife4j-UI

johnnymillergh · Jun 25, 2022 · c1b823c
1 parent f869645
commit c1b823c
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 20 deletions.
diff --git a/...y-web/src/main/kotlin/com/jmsoftware/maf/apigateway/configuration/OpenApiConfiguration.kt b/...y-web/src/main/kotlin/com/jmsoftware/maf/apigateway/configuration/OpenApiConfiguration.kt
@@ -36,7 +36,7 @@ class OpenApiConfiguration(
 
     @Bean
     fun openApi(): OpenAPI {
-        val projectArtifactId = mafProjectProperties.projectArtifactId
+        val projectArtifactId = mafProjectProperties.projectParentArtifactId
         val version = mafProjectProperties.version
         val developerEmail = mafProjectProperties.developerEmail
         val developerUrl = mafProjectProperties.developerUrl
@@ -62,7 +62,7 @@ class OpenApiConfiguration(
         swaggerUiConfigProperties.urls = mutableSetOf()
         mutableListOf<String>().apply {
             this.addAll(discoveryClient.services)
-            this.add(mafProjectProperties.projectArtifactId)
+            this.add(mafProjectProperties.projectArtifactId.removeSuffix("-bootstrap"))
         }.forEach { serviceName: String ->
             if (!CollUtil.contains(swaggerConfigurationProperties.ignoredServiceIds, serviceName)) {
                 log.warn("Found discovery client. Service name: $serviceName")

diff --git a/api-gateway/pom.xml b/api-gateway/pom.xml
@@ -81,6 +81,12 @@
             <version>${springdoc-openapi-ui.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-springdoc-ui</artifactId>
+            <version>${knife4j-springdoc-ui.version}</version>
+        </dependency>
+
         <!-- Test -->
         <dependency>
             <groupId>io.projectreactor</groupId>

diff --git a/pom.xml b/pom.xml
@@ -63,7 +63,8 @@
         <shardingsphere.version>5.1.2</shardingsphere.version>
         <hutool-all.version>5.8.3</hutool-all.version>
         <guava.version>31.1-jre</guava.version>
-        <springdoc-openapi-ui.version>1.6.6</springdoc-openapi-ui.version>
+        <springdoc-openapi-ui.version>1.6.9</springdoc-openapi-ui.version>
+        <knife4j-springdoc-ui.version>3.0.3</knife4j-springdoc-ui.version>
         <jjwt.version>0.11.5</jjwt.version>
         <java-faker.version>1.0.2</java-faker.version>
         <easyexcel.version>2.2.6</easyexcel.version>

diff --git a/...tlin/com/jmsoftware/maf/reactivespringcloudstarter/property/MafConfigurationProperties.kt b/...tlin/com/jmsoftware/maf/reactivespringcloudstarter/property/MafConfigurationProperties.kt
@@ -57,19 +57,6 @@ class MafConfigurationProperties {
      **/
     var webSecurityEnabled: Boolean = true
 
-    /**
-     * Web request log switch. Default is true.
-     *
-     * true - disable web request log; false - enable web request log.
-     **/
-    var webRequestLogEnabled: Boolean = true
-
-    /**
-     * Included package for http api scan, could be base package
-     **/
-    @NotBlank
-    var includedPackageForHttpApiScan: String = ""
-
     @PostConstruct
     private fun postConstruct() {
         log.warn("Initial bean: `${this.javaClass.simpleName}`")

diff --git a/...c/main/kotlin/com/jmsoftware/maf/springcloudstarter/configuration/OpenApiConfiguration.kt b/...c/main/kotlin/com/jmsoftware/maf/springcloudstarter/configuration/OpenApiConfiguration.kt
@@ -4,11 +4,13 @@ import cn.hutool.core.util.StrUtil
 import com.jmsoftware.maf.common.util.logger
 import com.jmsoftware.maf.springcloudstarter.property.MafProjectProperties
 import io.swagger.v3.oas.models.OpenAPI
+import io.swagger.v3.oas.models.Paths
 import io.swagger.v3.oas.models.info.Contact
 import io.swagger.v3.oas.models.info.Info
 import io.swagger.v3.oas.models.info.License
 import io.swagger.v3.oas.models.servers.Server
 import org.springdoc.core.customizers.OpenApiCustomiser
+import org.springframework.beans.factory.annotation.Value
 import org.springframework.context.annotation.Bean
 import java.util.function.Consumer
 
@@ -20,7 +22,9 @@ import java.util.function.Consumer
  * @author Johnny Miller (锺俊), e-mail: johnnysviva@outlook.com, date: 4/14/22 10:41 AM
  */
 class OpenApiConfiguration(
-    private val mafProjectProperties: MafProjectProperties
+    private val mafProjectProperties: MafProjectProperties,
+    @Value("\${spring.application.name}")
+    private val applicationName: String
 ) {
     companion object {
         private const val DEV = "development"
@@ -29,7 +33,7 @@ class OpenApiConfiguration(
 
     @Bean
     fun openApi(): OpenAPI {
-        val projectArtifactId = mafProjectProperties.projectArtifactId
+        val projectArtifactId = mafProjectProperties.projectParentArtifactId
         val version = mafProjectProperties.version