Skip to content

Add FAQ record for setting up swagger properties programmatically #31

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
bnasslahsen merged 1 commit into from
Feb 27, 2022
Merged

Add FAQ record for setting up swagger properties programmatically #31

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
13 changes: 13 additions & 0 deletions src/docs/asciidoc/faq.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,19 @@ springdoc.pathsToMatch=/v1, /api/balance/**
springdoc.packagesToScan=package1, package2
----

=== How can I set Swagger properties programmatically?

These can be set by creating a `swaggerUiConfig` bean as follows:

---
@Bean
fun swaggerUiConfig(config: SwaggerUiConfigProperties): SwaggerUiConfigProperties {
config.showCommonExtensions = true
config.queryConfigEnabled = true
return config
}
---

=== How can I ignore some field of model ?
* You can use the following annotation on the top of the field that you want to hide:
* `@Schema(hidden = true)`
Expand Down