Questions tagged [springdoc-openapi-ui]
365 questions
0
votes
1 answer
Springdoc OpenAPI displays class relationships under schemas and examples
I am using springdoc-openapi for REST API documentation. I have two classes which has One to One relationship between them. After I create the API, When I use the API. It returns exactly the way it stored in the database, but the example values or…
pavan sai
- 45
- 1
- 1
- 5
0
votes
1 answer
Custom Schema for Spring Boot 2 OpenAPI 3 Documentation
I have a requirement to integrate OpenAPI 3 documentation for my Spring Boot 2 project. We did not used modals/DTOs on controllers.
Here is the sample controller:
@RestController
@RequestMapping(value = "/pet")
public class PetController {
…
Shiva Prasad G
- 27
- 6
0
votes
1 answer
OpenAPI (Swagger) not working correctly with array type
I using SpringBoot and springdoc-openapi-ui. I have controller with method, which contain array as url param:
@Parameters(value = {
@Parameter(in = ParameterIn.QUERY, name = "output", example = "[f1,f2,f3]",
content…
All_Safe
- 1,339
- 2
- 23
- 43
0
votes
1 answer
springdoc openapi UI unresponsive, when large response is returned by the API
We have recently migrated from springfox to springdoc openapi 3. One of the API returns around 2MB of data and it works normally in springfox but springdoc openapi UI is unresponsive for few minutes and it takes more than 2 minutes to render as…
Tech Enthusiast
- 13
- 3
0
votes
1 answer
get schema from class with a generic type field in springdoc
I have rest services in springboot and using springdoc-openapi, and all my endpoints response with the same Class, like this:
public class ListResponse {
private List list;
private Integer statusHttp;}
and in the field "list" I add a differents…
juan ignacio
- 1
- 2
0
votes
2 answers
java.lang.IllegalStateException: Unable to read meta-data for class org.springdoc.core.SwaggerUiConfigProperties error
I have a Spring boot application. Where I have added this below dependency for Swagger API specification.
org.springdoc
springdoc-openapi-ui
…
Ana
- 161
- 1
- 2
- 9
0
votes
1 answer
How to display Json in OpenAPI UI with spring boot
I am trying to implement centralized swagger with openAPI 3.0 , but i am facing below issue:
I am able to get all openApi json from all the microservice and add in concurrentHaspMap.
serviceDescriptions = new ConcurrentHashMap
ashish969
- 11
- 2
0
votes
1 answer
How to change the name of the authorization key in the request header in the swagger-ui generated by springdoc-openapi-ui
My OpenAPI configuration
I need to change the header key from authorization to Authorization-internal
@Bean
public OpenAPI customOpenAPI(OpenApiConfig config) {
return new OpenAPI().addSecurityItem(new…
Gleidosn
- 193
- 1
- 6
0
votes
1 answer
Unable to hit controller even after authentication in springdoc
I am using springdoc version 1.4.3 and springdoc-security version 1.4.3 on my project with spring boot and spring security with the below configuration for my springdoc I am able to access swagger-ui.html but when I authorize(enter the token through…
Pseudo
- 56
- 1
- 2
- 12
0
votes
1 answer
OpenApi hide a model property in the request
I know we can use this @ApiModelProperty annotation from this link to hide an id from the request when we use Swagger-Ui
io.springfox
springfox-swagger-ui
…
Shailendra Madda
- 20,649
- 15
- 100
- 138
0
votes
1 answer
Springdoc Swagger 3 - Failed to load API definition after adding API Group
I have a Spring boot application that works perfectly fine with Springdoc until I add the following code to group the endpoints into a default group.
@Bean
public GroupedOpenApi hideApis() {
return…
Debargha Roy
- 2,320
- 1
- 15
- 34
0
votes
1 answer
SpringDoc (spring boot) utf-8 json header response for documentation
I'm using springdoc (springdoc-openapi-ui) for rest documentation for a kotlin spring boot application (Gradle build) and I want to know if there's a way to setup the response header content type encoding to utf-8. The defautlt returned content type…
0
votes
1 answer
How do I set up OAuth2.0 Request Headers
I wanted to put a value, like postman, on the SpringDoc Swagger page, and apply it to all requests
postman
swagger-ui
And swagger is not expected to pop up an input popup for user names and passwords.
Thanks for all the answers.
hero-zh
- 45
- 7
0
votes
1 answer
Where can I find API reference documentation for springdoc?
The springdoc-openapi java library is a decent library for integrating Open API 3 with Spring project (alternative for springfox).
I was searching for a reference documentation (like this for springfox); I found nothing but the official…
Tharindu Sathischandra
- 1,654
- 1
- 15
- 37
0
votes
1 answer
Springdoc-openapi. ClassNotFoundException: org.springframework.data.rest.webmvc.support.DefaultedPageable
After migration of Spring Boot to version 3.1 and springdoc-openapi libraries to 1.4.1:
springdoc-openapi-ui
springdoc-openapi-security
springdoc-openapi-data-rest
I faced issue ClassNotFoundException:…
Ruslan Kharevych
- 3
- 1
- 3