Questions tagged [springdoc-openapi-ui]
365 questions
1
vote
1 answer
SpringDoc swagger documentation generation exception in nested complextype
We have a Person class. Person class has a property with type PersonDetail. And PersonDetail has a property with type Mail class.
When we start the application and navigate to swagger ui html page, Mail class is not generated in components section…
Bilgehan
- 1,135
- 1
- 14
- 41
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
1
vote
1 answer
Springdoc Open API UI - BaseLayout doesn't works
I went through: https://springdoc.org/springdoc-properties.html#springdoc-openapi-core-properties before raisng the question, but look like things are not working.
I want to use BaseLayout and also wanted to change the theme of the Open API…
Jeff Cook
- 7,956
- 36
- 115
- 186
0
votes
0 answers
SpringDoc OpenApi - use objectmapper dynamically
I have a Kotlin Springboot app that uses springdoc-openapi for generating Swagger documentation.
The app uses snake case as the default, but there is one endpoint where I had to use camel case. So I added 2 object mappers to…
firstpostcommenter
- 2,328
- 4
- 30
- 59
0
votes
0 answers
openapi generator: Expected the field `xxx` to be an array in the JSON string but got `null`
I use spring-doc to generate yaml, then I want to use this yaml to generate java class by openapitools-generator, but there is an error: if there is a List with null, then error throw.
there are my code…
weiweiwei
- 31
- 5
0
votes
0 answers
Dynamic defaultValue for Pageable default-size in openapi for a spring boot 3 webflux controller
I am using a Pageable as a method parameter in a spring webflux controller.
I wanted to be able to override the default page size and the max size of the Pageable do a configurable property. I can do this using setters on the…
zargarf
- 633
- 6
- 18
0
votes
0 answers
OpenAPI v3 - how to clear input parameters on 'Try Out!'?
I have a Spring Boot application where we moved from OpenAPI declaration in a swagger.yaml file to annotations on methods like:
@Operation(summary = "Function to query something by some parameter")
@ApiResponses(value = {
…
gtludwig
- 5,411
- 10
- 64
- 90
0
votes
1 answer
Open API Code first, Polymorphic Map Values
I want to generate Open API specs from Java code (code first). I am doing it by using following dependencies
io.swagger.core.v3
swagger-annotations
…
Swapnil Kharabe
- 75
- 1
- 6
0
votes
1 answer
How to not expose entities endpoints in Spring Boot application
Upgrading my MS from Spring Boot 2.7 to 3.0, i've noticed that entities are exposed even i 'hide' and scan only controller package which contains only APIs,
for an entity Customer i could invoke all CRUD actions…
Mirlo
- 625
- 9
- 26
0
votes
1 answer
White label error 404 SPRING BOOT open api ui
Good morning everyone,
I am struggling with Open APi docs
I have the dependency in my pom.xml file:
…
user14304152
- 1
- 1
0
votes
0 answers
Springdoc Open API generation
My OenApiConfiguration looks like
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI().info(apiInfo()).components(new Components().addSecuritySchemes(OAUTH2, securityScheme()))
.addSecurityItem(new…
virot
- 1
- 2
0
votes
0 answers
Openapi-ui swagger example generating as null
Migrating from Springfox to Openapi.
The Swagger document is generated, but the request and response example is showing as null. whereas schema definition shows proper.
Is there any internal dependency required which is converting the schema to…
Shramik
- 81
- 8
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
Difference between my yaml file that i verify in swagger editor and swageer ui with spring doc
I have diff thing that is not shown in my swagger UI but it is written in my yaml file in the code.
I use spring doc for the génération of the UI.
for exemple i have multiple response http 200, 201 and i only see the 200
the description is not show…
0
votes
0 answers
[OpenApi v3]: Embedded @ArraySchema does not appear in example value
I have the following simple DTO:
public class AccountDto {
@Schema(example = "1", hidden = true)
private Long id;
@Schema(example = "100")
@NonNull private BigDecimal balance;
@Schema(example = "USD")
@NonNull private Currency…
Jason
- 2,495
- 4
- 26
- 37