Merge branch 'develop' into release

SMILEY4 · Apr 7, 2023 · 83d5186 · 83d5186
2 parents acf3a7b + 84126b5
commit 83d5186
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -27,13 +27,14 @@ A wiki with a short documentation is available [here](https://github.com/SMILEY4
 1. Add the JitPack repository
 ```kotlin
 repositories {
-    maven { url "https://jitpack.io" }
+    maven { url = uri("https://jitpack.io") }
 }
 ```
+
 2. Add the dependency
 ```kotlin
 dependencies {
-    implementation 'io.github.smiley4:ktor-swagger-ui:<VERSION>'
+    implementation "io.github.smiley4:ktor-swagger-ui:<VERSION>"
 }
 ```
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 group = "io.github.smiley4"
-version = "1.4.0"
+version = "1.5.0"
 
 repositories {
     mavenCentral()

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/dsl/OpenApiRoute.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/dsl/OpenApiRoute.kt
@@ -34,6 +34,12 @@ class OpenApiRoute {
     var deprecated: Boolean = false
 
 
+    /**
+     * Whether this route is hidden.
+     */
+    var hidden: Boolean = false
+
+
     /**
      * A declaration of which security mechanism can be used for this operation.
      * If not specified (and none specified with [securitySchemeNames]), defaultSecuritySchemeName (global plugin config) will be used

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/OApiPathsBuilder.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/OApiPathsBuilder.kt
@@ -21,15 +21,14 @@ class OApiPathsBuilder(private val routeCollector: RouteCollector) {
                 .filter { removeLeadingSlash(it.path) != removeLeadingSlash("${config.getSwaggerUI().swaggerUrl}/api.json") }
                 .filter { removeLeadingSlash(it.path) != removeLeadingSlash("${config.getSwaggerUI().swaggerUrl}/{filename}") }
                 .filter { !config.getSwaggerUI().forwardRoot || it.path != "/" }
+                .filter { !it.documentation.hidden }
                 .filter { path ->
                     config.pathFilter
                         ?.let { it(path.method, path.path.split("/").filter { it.isNotEmpty() }) }
                         ?: true
                 }
                 .onEach { logger.debug("Configure path: ${it.method.value} ${it.path}") }
-                .map {
-                    pathBuilder.build(it, components, config)
-                }
+                .map { pathBuilder.build(it, components, config) }
                 .forEach { addToPaths(this, it.first, it.second) }
         }
     }

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/RouteCollector.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/RouteCollector.kt
@@ -107,6 +107,7 @@ class RouteCollector {
                 b.securitySchemeNames?.let { merged.addAll(it) }
             }
             deprecated = a.deprecated || b.deprecated
+            hidden = a.hidden || b.hidden
             request {
                 (getParameters() as MutableList).also {
                     it.addAll(a.getRequest().getParameters())

diff --git a/src/test/kotlin/io/github/smiley4/ktorswaggerui/examples/CompleteExample.kt b/src/test/kotlin/io/github/smiley4/ktorswaggerui/examples/CompleteExample.kt
@@ -21,6 +21,7 @@ import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.server.request.receive
 import io.ktor.server.response.respond
 import io.ktor.server.response.respondText
+import io.ktor.server.routing.get
 import io.ktor.server.routing.routing
 import java.util.Random
 
@@ -249,5 +250,12 @@ private fun Application.myModule() {
 
         }
 
+        get("hidden", {
+            hidden = true
+            description = "This route is hidden and not visible in swagger"
+        }){
+            call.respond(HttpStatusCode.NotImplemented, "todo")
+        }
+
     }
 }