Questions tagged [springdoc-openui]
43 questions
2
votes
1 answer
Springdoc extension for AWS API Gatewary
I want to migrate from springfox 2 to springdoc. Currently, there are multiple plugins (springfox.documentation.spi.service.OperationBuilderPlugin) implemented using the support available in the springfox library.
The plugin of AWS API Gateway is…

Stoean Robert
- 83
- 5
2
votes
1 answer
OpenApiCustomiser bean does not contain all info
With this controller definition, with a tag:
@RestController
@RequestMapping("/some_path")
@Tag(name = "MyController")
public class MyController {
...
}
When trying to customize OpenApi, I can't get the value of tags:
@Bean
public…

C.P.O
- 1,213
- 2
- 11
- 29
2
votes
2 answers
Spring-Doc open api not working with Spring cloud config server @EnableConfigServer
Im using spring boot 2.3.2.RELEASE with spring-cloud-config-server 2.2.4.RELEASE. Im trying to implement the spring-doc-openapi (1.4.3) in a existing project. If i add @EnableConfigServer in one the configuration class file, the swagger-ui.html…

Primus
- 33
- 7
2
votes
2 answers
Adding Actuator as a groupedOpenApi
Could we add Actuator endpoints as a groupedOpenApi that will be gourped separately ?
ex :
@bean
public GroupedOpenApi actuatorApi() {
return…

Yawyaw1
- 83
- 1
- 8
2
votes
1 answer
Springdoc-openapi - Is there any way to override default value as null or empty in the POST request?
I am using Spring Boot and Open API 3. Through OAS2 Swagger when I make a POST request, I see that all String fields are coming default value as a Spring and I don't see a way to remove it, either through SpringDoc Open UI nor through code.
{
…

PAA
- 1
- 46
- 174
- 282
2
votes
1 answer
Open API Spec3 - How to display a drop-down or a way to select an input from multiple inputs?
I am working on Spring Boot & Open API Spec3 using springdoc-openapi-ui. How to display a drop-down or a way to select an input from multiple inputs? I went through https://github.com/swagger-api/swagger-ui/issues/685, I need something like…

PAA
- 1
- 46
- 174
- 282
2
votes
1 answer
How I can ignore PathVariable conditionally on swagger ui using springdoc openapi
I am migrating from springfox 2.9.0 to springdoc-openapi-ui 1.2.33.
I have a requirement to show or hide the PathVariable on swagger ui based on condition.
I have two paths like below
String nameIdentifier = "{fisrtName}/{lastName}"
String…

SSK
- 3,444
- 6
- 32
- 59
2
votes
2 answers
How to generate RequestBody of type Map using springdoc for swagger open api 3.0?
For the following code, only Parameter id is getting generated and its completely missing the "Request body" section.
I added type="object" based on https://swagger.io/docs/specification/data-models/dictionaries/ .
public Item addProperties(
…

Andrew A
- 21
- 1
- 2
1
vote
0 answers
JacksonAnnotationIntrospector is not working properly with Spring doc Schema
I have some API defined using Spring codegen, and the snippet for @ApiResponse is defined below:
@ApiResponse(responseCode = "201", description = "Created successfully", content = @Content(mediaType = "application/json", schema =…

mdanish98
- 65
- 8
1
vote
1 answer
How to customized and Override Parameter Values from POJO?
I am working on Spring Boot v2.2.6.RELEASE and Open API Integration example. This example has capability to search using 20 different parameters. So this POJO class holds CustomSearchDto these 20 different values.
In the POJO I used orgName, but…

Jeff Cook
- 7,956
- 36
- 115
- 186
1
vote
1 answer
How to generate a nullable field of a type that maps to json object with springdoc-openapi / swagger?
First of all, the following repository has all the code (and description as well) to reproduce this problem: https://github.com/elgleidson/swagger-problem
I have the following JSON:
{
"nonNullableField": "not null",
"nullableField": null,
…

elgleidson
- 74
- 1
- 4
0
votes
0 answers
Swagger UI issue when having same root context for two different applications
Getting swagger UI issue when two different microservice having same application root context deployed on sandbox environment.
we are using ngnix as reverse proxy routing server between client and backend server.
So from Ngnix we are unable to…

Deepak K
- 1
- 1
0
votes
0 answers
Springdoc add automaticaly response based on return class
I am migrating some code from springfox to springdoc. The code from springfox has a functionality to make the documentation of http 200 response automaticaly based on return class.
I am trying to achieve that using Operation customizer…

tschi
- 26
- 4
0
votes
0 answers
Springdoc 2.1.0 "No API definition provided." Not scanning endpoints
I am on Spring boot 3.1.0 and Spring doc 2.1.0.
Previously I was using springfox and I was forced to migrate to springdoc since springfox didn't support springboot 3.
I followed migration guide this migration guide and here's how my setup looks…

Arun Gowda
- 2,721
- 5
- 29
- 50
0
votes
0 answers
Springdoc with multiple api-doc in diferent URL and PATH
I have an api in java 8 with springboot 2.7.5 and springdoc-openapi-ui 1.7.0 version.
I have three controller in this api like this:
/controllerOne
(group = ControllerOne)
/controllerTwo
(group = ControllerTwo)
/controllerThree
(group =…