Merge branch 'bugfix/2-missing-security-schemes' into release

SMILEY4 · Sep 14, 2022 · 3db9bb6 · 3db9bb6
2 parents 715bb12 + 83336b8
commit 3db9bb6
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 20 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -6,7 +6,7 @@ plugins {
 }
 
 group = "io.github.smiley4"
-version = "0.5.0"
+version = "0.5.1"
 
 repositories {
     mavenCentral()

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/SwaggerPlugin.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/SwaggerPlugin.kt
@@ -53,9 +53,6 @@ private fun getBuilder(): ApiSpecBuilder {
     return ApiSpecBuilder(
         OApiInfoBuilder(),
         OApiServersBuilder(),
-        OApiSecuritySchemesBuilder(
-            OApiOAuthFlowsBuilder()
-        ),
         OApiTagsBuilder(),
         OApiPathsBuilder(
             RouteCollector(),
@@ -87,7 +84,10 @@ private fun getBuilder(): ApiSpecBuilder {
             ),
         ),
         OApiComponentsBuilder(
-            OApiExampleBuilder()
+            OApiExampleBuilder(),
+            OApiSecuritySchemesBuilder(
+                OApiOAuthFlowsBuilder()
+            )
         ),
     )
 }

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/ApiSpecBuilder.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/ApiSpecBuilder.kt
@@ -12,7 +12,6 @@ import io.swagger.v3.oas.models.OpenAPI
 class ApiSpecBuilder(
     private val infoBuilder: OApiInfoBuilder,
     private val serversBuilder: OApiServersBuilder,
-    private val securitySchemesBuilder: OApiSecuritySchemesBuilder,
     private val tagsBuilder: OApiTagsBuilder,
     private val pathsBuilder: OApiPathsBuilder,
     private val componentsBuilder: OApiComponentsBuilder
@@ -26,14 +25,9 @@ class ApiSpecBuilder(
         val openAPI = OpenAPI().apply {
             info = infoBuilder.build(config.getInfo())
             servers = serversBuilder.build(config.getServers())
-            if (config.getSecuritySchemes().isNotEmpty()) {
-                components = Components().apply {
-                    securitySchemes = securitySchemesBuilder.build(config.getSecuritySchemes())
-                }
-            }
             tags = tagsBuilder.build(config.getTags())
             paths = pathsBuilder.build(config, application, componentCtx)
-            components = componentsBuilder.build(componentCtx)
+            components = componentsBuilder.build(componentCtx, config.getSecuritySchemes())
         }
         return Json.pretty(openAPI)
     }

diff --git a/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/OApiComponentsBuilder.kt b/src/main/kotlin/io/github/smiley4/ktorswaggerui/specbuilder/OApiComponentsBuilder.kt
@@ -1,20 +1,25 @@
 package io.github.smiley4.ktorswaggerui.specbuilder
 
+import io.github.smiley4.ktorswaggerui.dsl.OpenApiSecurityScheme
 import io.swagger.v3.oas.models.Components
 
 /**
  * Builder for the OpenAPI Components Object
  */
 class OApiComponentsBuilder(
-    private val exampleBuilder: OApiExampleBuilder
+    private val exampleBuilder: OApiExampleBuilder,
+    private val securitySchemesBuilder: OApiSecuritySchemesBuilder
 ) {
 
-    fun build(ctx: ComponentsContext): Components {
+    fun build(ctx: ComponentsContext, securitySchemes: List<OpenApiSecurityScheme>): Components {
         return Components().apply {
             schemas = ctx.schemas
             examples = ctx.examples.mapValues {
                 exampleBuilder.build("", it.value, ComponentsContext.NOOP)
             }
+            if (securitySchemes.isNotEmpty()) {
+                this.securitySchemes = securitySchemesBuilder.build(securitySchemes)
+            }
         }
     }
 

diff --git a/src/test/kotlin/io/github/smiley4/ktorswaggerui/tests/BuilderUtils.kt b/src/test/kotlin/io/github/smiley4/ktorswaggerui/tests/BuilderUtils.kt
@@ -22,9 +22,6 @@ fun getApiSpecBuilder(): ApiSpecBuilder {
     return ApiSpecBuilder(
         OApiInfoBuilder(),
         OApiServersBuilder(),
-        OApiSecuritySchemesBuilder(
-            OApiOAuthFlowsBuilder()
-        ),
         OApiTagsBuilder(),
         OApiPathsBuilder(
             RouteCollector(),
@@ -56,7 +53,10 @@ fun getApiSpecBuilder(): ApiSpecBuilder {
             ),
         ),
         OApiComponentsBuilder(
-            OApiExampleBuilder()
+            OApiExampleBuilder(),
+            OApiSecuritySchemesBuilder(
+                OApiOAuthFlowsBuilder()
+            ),
         ),
     )
 }
@@ -68,7 +68,10 @@ fun getOApiInfoBuilder(): OApiInfoBuilder {
 
 fun getOApiComponentsBuilder(): OApiComponentsBuilder {
     return OApiComponentsBuilder(
-        OApiExampleBuilder()
+        OApiExampleBuilder(),
+        OApiSecuritySchemesBuilder(
+            OApiOAuthFlowsBuilder()
+        )
     )
 }
 

diff --git a/src/test/kotlin/io/github/smiley4/ktorswaggerui/tests/ComponentsObjectTest.kt b/src/test/kotlin/io/github/smiley4/ktorswaggerui/tests/ComponentsObjectTest.kt
@@ -201,7 +201,7 @@ class ComponentsObjectTest : StringSpec({
     companion object {
 
         private fun buildComponentsObject(context: ComponentsContext): Components {
-            return getOApiComponentsBuilder().build(context)
+            return getOApiComponentsBuilder().build(context, listOf())
         }
 
         private fun buildSchema(type: KClass<*>, context: ComponentsContext): Schema<*> {