Questions tagged [springdoc-openapi-ui]
365 questions
0
votes
1 answer
Open API UI 3.0.0 Hide Schema at the bottom without removing them from the API endpoint documentation
I have been working with open api ui 3.0.0 and when I give annotations on API endpoints the APIs are shown on swagger endpoint. But interestingly there is a list of schemas that shows DTOs used in the endpoints. I need to remove those endpoints. So…

pacman
- 725
- 1
- 9
- 28
0
votes
1 answer
Swagger UI - Load custom file.yaml/json instead default configuration
I'm developing an SpringBoot REST project which runs perfectly. I'm trying to implement the OpenApi-ui in the project. It's working fine by default but I'd like to use my own yaml/json information file instead the default info.
I have been following…

RubenEs
- 31
- 4
0
votes
0 answers
Can't set mapping for dynamic URL in SpringDoc OpenAPI
I want make Swagger specification for my API. But customers use my API can create and delete some entity on server. Each entity have only one type and can include other entity.
Example of…

kosmo flyko
- 1
- 1
0
votes
1 answer
OpenApi - required a bean of type 'org.springdoc.webmvc.ui.SwaggerIndexTransformer' that could not be found
I'm adding Swagger to my Spring Webflux service with functional controller. First I was getting this error:
Description:
The bean 'swaggerWelcome', defined in class path resource
[org/springdoc/webflux/ui/SwaggerConfig.class], could not…

AleGallagher
- 1,745
- 7
- 30
- 40
0
votes
0 answers
how to enable showing tag categories in openapi 3 swagger ui
I use springdoc openapi version 1.5.7. left list of tags not showing. how can I enable it?

Bashir Zamani
- 100
- 1
- 2
- 6
0
votes
1 answer
Spring boot REST API remove duplicated response body
So I'm using springdoc-openapi-ui and I am able to produce the API which is accessible with swagger UI.
However, I've noticed that all response codes in the swagger UI copy the response code from the one returned by 200 response code, something…

TheRealChx101
- 1,468
- 21
- 38
0
votes
1 answer
How can I add swagger open api 3.0 configuration for secured api's
I've enabled the Swagger open API 3.0 like below:
Added following dependencies
org.springdoc
springdoc-openapi-ui
1.5.2
…

Mahesh Yadav
- 240
- 2
- 3
- 13
0
votes
1 answer
Disable WADL endpoint generation in swagger documentation using springdoc-openapi
I have a spring boot application that has swagger documentation enabled using springdoc-openapi. For some reason there is an endpoint called /application.wadl is getting created automatically without adding any logic. Is there any way to disable…

ark
- 3,707
- 5
- 21
- 36
0
votes
1 answer
Spring Boot Open Api Request LocalTime
I use Spring Boot 2.4.5, springdoc-openapi-ui 1.5.7,
My Entity has fields:
private LocalDate beginDate;
private LocalTime beginTime;
Request body
This option does not work
{
"beginDate": "2021-04-25",
"beginTime": {
"hour": 0,
"minute":…

Mihail Artyugin
- 3
- 1
0
votes
1 answer
XML examples in springdoc-openapi, swagger UI
I’m struggling with generation of correct XML examples in springdoc-openapi library.
Controller:
@RestController
@RequestMapping(produces = { MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE })
public class MyController {
…

John Smith
- 333
- 2
- 11
0
votes
1 answer
Springdoc configUrl behind api gateway
I have springdoc swagger ui up and running with a spring cloud gateway route /myapi. So when I hit the url
https://myhost.com/myapi
it redirects me to a url
https://myhost.com/myapi/webjars/swagger-ui/index.html?configUrl=/swagger-config.json
I…

Vishal
- 549
- 3
- 13
0
votes
1 answer
Group APIs by parameter or tag or any different key
I have four types of API which needs to be grouped:
profileOne = path: v1/profileOne/
profileTwo = path: v1/profileTwo/
common = path: v1/common (could be accessible by both profiles)
But I also have some APIs for example:
v1/test and v1/hello which…

Guilherme Bernardi
- 490
- 1
- 6
- 18
0
votes
1 answer
How can we add to the default response codes in Spring docs Open API on actuator endpoints such as /health?
I am able to display the actuator endpoints in my API through this config:
springdoc:
show-actuator: true
I am able to manage the http mappings of my /health endpoint with this config:
management:
endpoint:
health:
status:
…
0
votes
1 answer
Automatic Swagger annotation-based description generation in Springdoc
Basically my question is the same as this one but for Springdoc (and not Springfox).
In short, I have a Spring-boot app and I am using spring-security @PreAuthorize annotation to secure some of my apis, currently based on hasAuthority only.
Is there…

Y. Sobelman
- 186
- 1
- 7
0
votes
0 answers
springdoc-openapi : not showing correct tag when init
I am using springdoc-openapi to create API documentation and I'm using $ref to reference the external yaml file.
Here's my config:
tags:
- name: example
description: 'Description for Example'
paths:
/example/{id}/{pathParam2}:
get:
…

huynhtamhao
- 9
- 1