Skip to content

feat: support withCredentials in Swagger UI #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dzikoysk merged 1 commit into from
Sep 21, 2026
Merged

feat: support withCredentials in Swagger UI #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...avalin-swagger-plugin/src/main/kotlin/io/javalin/openapi/plugin/swagger/SwaggerHandler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class SwaggerHandler(
private val versions: List<SwaggerVersionMapping>,
private val swaggerVersion: String,
private val validatorUrl: String?,
private val withCredentials: Boolean,
private val routingPath: String,
private val basePath: String?,
private val tagsSorter: String,
Expand Down Expand Up @@ -117,6 +118,7 @@ class SwaggerHandler(
layout: "StandaloneLayout",
tagsSorter: $tagsSorter,
operationsSorter: $operationsSorter,
withCredentials: $withCredentials,
validatorUrl: ${if (validatorUrl != null) "\"$validatorUrl\"" else "null"}
})
}
Expand Down
7 changes: 7 additions & 0 deletions ...javalin-swagger-plugin/src/main/kotlin/io/javalin/openapi/plugin/swagger/SwaggerPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ class SwaggerConfiguration @JvmOverloads constructor(
@JvmField var title: String = "OpenApi documentation",
/** Specification validator */
@JvmField var validatorUrl: String? = "https://validator.swagger.io/validator",
/** Enables passing credentials, such as cookies, in CORS requests that are sent by the browser. */
@JvmField var withCredentials: Boolean = false,
/** Tags sorter algorithm expression. */
@JvmField var tagsSorter: String = "'alpha'",
/** Operations sorter algorithm expression. */
Expand Down Expand Up @@ -64,6 +66,10 @@ class SwaggerConfiguration @JvmOverloads constructor(
/** Set specification validator URL */
fun withValidatorUrl(url: String?): SwaggerConfiguration = also { validatorUrl = url }

/** Enable passing credentials in CORS requests */
@JvmOverloads
fun withCredentials(enabled: Boolean = true): SwaggerConfiguration = also { withCredentials = enabled }

/** Set tags sorter algorithm expression */
fun withTagsSorter(sorter: String): SwaggerConfiguration = also { tagsSorter = sorter }

Expand Down Expand Up @@ -113,6 +119,7 @@ open class SwaggerPlugin @JvmOverloads constructor(
},
swaggerVersion = pluginConfig.version,
validatorUrl = pluginConfig.validatorUrl,
withCredentials = pluginConfig.withCredentials,
routingPath = state.router.contextPath,
basePath = pluginConfig.basePath,
tagsSorter = pluginConfig.tagsSorter,
Expand Down
Loading