Questions tagged [springdoc-openapi-ui]
365 questions
1
vote
1 answer
Use springdoc in Spring MVC project with custom message converters
Adding springdoc to an existing Spring MVC REST API project causes problems with custom message converters. The project configures custom message converters to set the date output to a specific format and to remove fields that contain null. This is…

Pieter
- 115
- 1
- 1
- 11
1
vote
1 answer
Swagger-UI (v3) with org.springdoc does show and interpret enums incorrectly
I have a problem with my Swagger-UI: It does show Enums as intended.
Instead of a simple representation like CATEGORY1 it shows the full class like CATEGORY1(name=Cat 1) and also uses it in the requests like…

blackwodka86
- 31
- 5
1
vote
2 answers
SpringDoc/Swagger behind an nginx proxy
We are running a service behind an nginx proxy so that:
http://service-post:8080/swagger-ui.html is routed to public address https://host.com/services/post/swagger-ui.html
Or to define from the other way:
When nginx receives request on…

Vojtěch
- 11,312
- 31
- 103
- 173
1
vote
1 answer
How to sort endpoint in reverse order using springdoc-openapi
I am using spring doc-open API with version (1.2.32). Now I would like to sort my endpoints in UI by its HTTP method (reverse order) and I am not using any tags on my endpoint method.
If I have 4 endpoint post, get, put, delete
then I want to…

Rubeena
- 171
- 1
- 3
- 11
1
vote
1 answer
What is the Springdoc equivalent of the Swagger 2 Springfox useDefaultResponseMessages() method?
We are moving away from Springfox to Springdoc and would like to know if Springdoc has a useDefaultResponseMessages() equivalent?
Have seen some solutions that require some coding but what I would like to know if there is something that can be…

VianneN
- 143
- 3
- 12
1
vote
1 answer
Springdoc with multiple api-docs
I want to group three API docs in one swagger-ui. I use Springdoc. Each of the three API-docs has its own url. (They are not in the same project).
Is there a way to do this?
Edit: It's now working this way:
springdoc:
swagger-ui:
path: /
…

Iori Yagami
- 387
- 1
- 3
- 18
1
vote
1 answer
How to change text present on swagger authorization screen using springdoc
I want to change the text present on the swagger authorization UI screen.
I want to change the Authorized label to Stored.
Please find the below screenshot from swagger UI authorization screen
The reason I want to change it as it is miss leading.…

SSK
- 3,444
- 6
- 32
- 59
1
vote
3 answers
Springdoc - How do I add externalDocs to OpenAPI swagger UI auto generated documentation
So I have a spring boot project that I just added OpenAPI Swagger UI to. It auto generates the documentation really well for all of our controllers and models. But I would like to add some additional configuration such as externalDocs as shown…

Dylan
- 2,161
- 2
- 27
- 51
1
vote
2 answers
X-Forwarded-For does not appear when I click" Try it out" in swagger-ui.html
I have a sample github using springdoc : https://github.com/vmisra2018/sb-example-swaggerdoc
and I can't figure out how can I enable X-Forwarded-For for any api eg:" /person " when i click try-it-out
To Reproduce
Steps to reproduce the…

Vivek Misra
- 165
- 2
- 15
1
vote
2 answers
springdoc-openapi-ui can not render Protobuf Models causing the browser to crash
Migrating from springfox-swagger-ui to springdoc-openapi-ui causes the same issue described here:
https://github.com/springfox/springfox/issues/2459
I faced the issue for springfox-swagger-ui too but I was able to make it work with a similar…

Francisco José Martínez Páez
- 337
- 1
- 3
- 16
1
vote
1 answer
Is Springdoc swagger not possible when passing HttpServletRequest as method param?
I have below springboot rest controller and using springdoc-openapi. My springboot rest service has to cater to some legacy application( which is the only client which calls this service) and I need to have HttpServletRequest as param.
I am…

Vivek Misra
- 165
- 2
- 15
1
vote
1 answer
springdoc-openapi: How can I use @RouterOperation in coRouter DSL
I'm using springdoc-openapi with Kotlin and WebFlux.fn.
I wanted to use @RouterOperation annotation at every path in CoRouterFunctionDsl but I couldn't.
@Configuration
class UserRouter(private val userHandler: UserHandler) {
// @RouterOperations…

gumimin
- 13
- 1
- 3
1
vote
3 answers
Springdoc: got 404 when open swagger-ui.html
I got latest Spring Boot app and springdoc.swagger-ui on board.
io.swagger
swagger-annotations
1.6.1
…

splekhanov
- 116
- 1
- 2
- 9
1
vote
1 answer
Authorization Header not getting displayed in CURL springdoc-openapi-ui
I am using the springdoc-openapi-ui. I have configured the global headers named Authorization.
When I execute the API Authorization is not showing in the CURL of the requests. My other parameters are showing in the CURL except…

SSK
- 3,444
- 6
- 32
- 59
1
vote
1 answer
Disable sorting fields value alphabetically
I am using Spring Boot (v2.1.3 RELEASE) and SpringDoc. I already went through https://springdoc.org/springdoc-properties.html and https://springdoc.org/, but it looks like SpringDoc is automatically sorting the parameters alphabetically. How can we…

Jeff Cook
- 7,956
- 36
- 115
- 186