Skip to content

Commit a64ff26

Browse files
authored
Merge pull request #13 from aoudiamoncef/master
refactor: add springdoc.swagger-ui.enabled documentation
2 parents 48b7011 + 53fe7db commit a64ff26

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

springdoc-properties.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ springdoc.pre-loading-enabled | `false` | `Boolean`. Pre-loading setting to loa
5757
| Parameter name | Default Value | Description |
5858
|:---------------|:------------------|:------------|
5959
springdoc.swagger-ui.path | `/swagger-ui.html` |`String`, For custom path of the swagger-ui HTML documentation.
60+
springdoc.swagger-ui.enabled | `true` | `Boolean`. To disable the swagger-ui endpoint (/swagger-ui.html by default).
6061
springdoc.swagger-ui.configUrl | `/v3/api-docs/swagger-config` | `String`. URL to fetch external configuration document from.
6162
springdoc.swagger-ui.layout | `BaseLayout` | `String`. The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
6263
springdoc.swagger-ui.validatorUrl | `null` | By default, Swagger UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it to `null` will disable validation.
@@ -96,4 +97,4 @@ springdoc.swagger-ui.csrf.header-name | `X-XSRF-TOKEN` | `String`. Optional CSRF
9697
springdoc.swagger-ui.syntaxHighlight.activated | `true` | `Boolean`. Whether syntax highlighting should be activated or not.
9798
springdoc.swagger-ui.syntaxHighlight.theme | `agate` | `String`. `String=["agate"*, "arta", "monokai", "nord", "obsidian", "tomorrow-night"]`. [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. (Only these 6 styles are available.)
9899

99-
[back](./)
100+
[back](./)

0 commit comments

Comments
 (0)