Questions tagged [springdoc-openapi-ui]
365 questions
3
votes
2 answers
Spring boot bean name conflict in two external packages with no controll of the external code
I'm trying to use two dependencies in Spring Boot 3.0.0
org.springdoc
springdoc-openapi-starter-webmvc-ui
2.0.2
…
PlickPlick
- 197
- 15
3
votes
2 answers
Spring Rest Controller API with HttpEntity getting null body when testing with Open API
I'm using Spring Boot 2.6.7 and Using Open API springdoc-openapi-ui 1.6.4. I have 2 services. From first service I'm using rest template to connect to second service.
In the first service, in rest controller api, I have used HttpEntity to get…
iCode
- 8,892
- 21
- 57
- 91
3
votes
0 answers
How to control which OpenAPI groups will be avilable in SwaggerUI based on user's role
I have following bean
@Bean
public GroupedOpenApi myGroup1() {
return GroupedOpenApi.builder()
.group("My Group 1")
.pathsToMatch("/api/group1/**")
.build();
}
I have also swagger-ui,…
Mar Ek
- 31
- 2
3
votes
1 answer
@ApiModelProperty to @Schema
I'm trying to migrate springfox to springdoc using this code:
import io.swagger.annotations.ApiModelProperty;
@ApiModelProperty(position = 30, required = true, value = "Group value")
to
import…
Peter Penzov
- 1,126
- 134
- 430
- 808
3
votes
1 answer
spring boot - springdoc open api: No api definiation provided error
I need to document my spring boot application's rest apis with SpringDoc OpenApi. So, I added this dependency in my pom.xml:
org.springdoc
springdoc-openapi-ui
…
hamed
- 7,939
- 15
- 60
- 114
3
votes
1 answer
springdoc-openapi not including global headers or responses in api-docs
We are porting springfox to springdoc and are having issues getting the global parameters and default responses to show up in the /v3/api-docs response.
They show up fine in the Swagger UI but not in the json returned from /v3/api-docs. We are…
Ens
- 308
- 3
- 15
3
votes
1 answer
No API definition provided. - openApi - springdoc
I have a simple boot application where I have added open api swagger dependency
springdoc-openapi-ui
along with these…
akaliza
- 3,641
- 6
- 24
- 31
3
votes
1 answer
How to display x-www-form-urlencoded format request with springdoc-openapi-ui
My environment
springboot:2.6.4
springdoc-openapi-ui:1.6.6
Probrem
I want to create an API definition to receive requests in x-www-form-urlencoded format.
Using @RequestBody will create a swagger-ui display with no Parameter notation, just the body.…
aoiro27
- 31
- 1
3
votes
1 answer
springdoc Swagger UI not POSTing JSON
I have a Spring Boot REST app that is Swagger-enabled using springdoc-openapi-ui. For the life of me, I can't get the generated Swagger UI to actually POST JSON. Instead, the frontend passes args as request parameters. How do I get the Swagger UI to…
Noky
- 471
- 1
- 4
- 11
3
votes
1 answer
OpenAPI java generate-sources client... How to add "new header" not mentioned in yml before firing http request
OpenAPI client generation module generates client-code(ApiClient-RestTemplate and APISpecificClient which uses ApiClient)
The contract is always strict. Ex: I have to specify in:header in:path in:query for the etc... for API request and…
3
votes
3 answers
How do I configure a custom URL for the springdoc swagger-ui HTML page?
After adding the springdoc-openapi-ui dependency to my Spring project (not Spring Boot) OpenAPI V3 documentation is generated and can be viewed using the default swagger-ui page: localhost:8080/swagger-ui.html. Because the springdoc documentation…
Pieter
- 115
- 1
- 1
- 11
3
votes
1 answer
Swagger UI with springdoc-openapi-ui doesn't show the APIs in the generated "@Controller" class
I have a Spring Boot application where the API is specified as a OpenAPI 3.0.2 YAML document. I used the openapi-generator-maven-plugin to generate code from the spec. When I open up http://localhost:8080/swagger-ui.html, it displays: "No operations…
devurandom
- 61
- 1
- 4
3
votes
2 answers
How to create notes/description based on custom Annotation to Swagger
I have a Springboot Rest application where I have annotation which is automatically converted API's and Params.
I have custom annotation where i include some notes to it, How can i get that generated to my swagger page in OpenAPI…
Muthukumar
- 93
- 2
- 3
- 10
3
votes
2 answers
OpenAPI & spring-doc not finding all mappings in a controller class
This is a bit weird. springdoc-openapi-ui v1.2.32, the generated docs contain only a few of the mappings within a controller.
Example:
@Operation(
summary = "Foo",
description = "Foo"
)
…
Half_Duplex
- 5,102
- 5
- 42
- 58
3
votes
1 answer
Configure Open API 3 on a Spring project (not Spring Boot)
After following @Zagrebin-Victor advice, I have a Spring MVC project running OpenAPI 3 (springdoc-openapi-1.5.3)
Following this FAQ I defined this on a property file:
springdoc.swagger-ui.disable-swagger-default-url=true
So no "Petstore API" is…
floss.dev
- 81
- 6