Stack Overflow
Stack Overflow

Questions tagged [springdoc]

The springdoc-openapi Java library helps automating the generation of API documentation using Spring Boot projects. springdoc-openapi works by examining an application at runtime to infer API semantics based on Spring configurations, class structure and various annotations.

The springdoc library automatically generates documentation in JSON/YAML and HTML formatted pages. The generated documentation can be complemented using swagger-annotations.

Useful links:

471 questions
62
votes
2 answers

Migrating from Springfox Swagger 2 to Springdoc Open API

I try to follow these: https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ How do I deal with annotations like: @ApiModel(value = "Response container") @ApiModelProperty(value = "Iventory response",…
Kalpesh Soni
  • 6,879
  • 2
  • 56
  • 59
49
votes
4 answers

Enable Authorize button in springdoc-openapi-ui for Bearer Token Authentication (JWT)

How to enable "Authorize" button in springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) for Bearer Token Authentication, for example JWT. What annotations have to be added to Spring @Controller and @Configuration classes?
Eugene Khyst
  • 9,236
  • 7
  • 38
  • 65
25
votes
7 answers

springboot swagger3 "Failed to load remote configuration."

Spring Boot 2.6.3 with Springdoc. org.springdoc springdoc-openapi-ui 1.6.5 In applicaton.yaml, when I set…
QiangLi
  • 251
  • 1
  • 3
  • 3
22
votes
9 answers

Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()" because "this.condition" is null

I'm trying to run Springdoc with Spring Boot 2.6.7. Configuration: @Configuration public class SwaggerConfiguration { @Bean public GroupedOpenApi publicApi() { return GroupedOpenApi.builder() .group("springshop-public") …
Peter Penzov
  • 1,126
  • 134
  • 430
  • 808
21
votes
3 answers

springdoc-openapi apply default global SecurityScheme possible?

I have the following SecurityScheme definition using springdoc-openapi for java SpringBoot RESTful app: @Bean public OpenAPI customOpenAPI() { return new OpenAPI() .components(new…
Cortlendt
  • 2,190
  • 4
  • 29
  • 50
18
votes
2 answers

Are there any advantages of using/migrating to springdoc-openapi from Springfox?

For enabling Swagger in SpringBoot 2.7 what are the advantages/disadvantages of choosing springdoc-openapi over Springfox
Deepjyoti Dutta
  • 201
  • 1
  • 2
  • 7
18
votes
5 answers

petstore URL not disabled in SpringDoc OpenAPi

I am using SpringDoc 1.4.3 for swagger. I have added the below configuration to disabled the petstore URLs in application.yml Configuration springdoc: swagger-ui: disable-swagger-default-url: true tags-sorter: alpha operations-sorter:…
SSK
  • 3,444
  • 6
  • 32
  • 59
18
votes
1 answer

Enable Authorize button in springdoc-openapi-ui for Basic Authentication

How to enable "Authorize" button in springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) for Basic Authentication. What annotations have to be added to Spring @Controller and @Configuration classes?
Eugene Khyst
  • 9,236
  • 7
  • 38
  • 65
18
votes
1 answer

How to display app API documentation by using springdoc-openapi-webflux-ui?

I read this https://springdoc.org/demos.html to use springdoc-openapi-webflux-ui. As documentation said I just added springdoc-openapi-webflux-ui library to my app: implementation('org.springdoc:springdoc-openapi-webflux-ui:1.2.26') Additionally, I…
Seydazimov Nurbol
  • 1,404
  • 3
  • 10
  • 25
16
votes
10 answers

SpringDoc openAPI tool not scanning for APIs in Spring Boot Project

I'm having trouble getting this to work. I've started with a working SpringBoot (v2.2.2) app with a working @RestController. To get springdoc to work I've included the following dependency in my pom: org.springdoc …
Vincent Fumo
  • 361
  • 1
  • 2
  • 9
16
votes
6 answers

How to Integrate Open API 3 with Spring project (not Spring Boot) using springdoc-openapi

My Existing Project is on Spring Framework not Spring Boot. I want to integrate Open API 3 with it. I want to integrate using springdoc-openapi not using Jersey.
Ashish Kumar
  • 409
  • 1
  • 4
  • 12
15
votes
5 answers

springdoc-openapi-ui How do I set the request to HTTPS

When I publish, I will use HTTPS requests instead of HTTP, but swagger original URL is still HTTP, I have no idea how to set it up, and there is no documentation for servers in the original springdoc-openapi-ui…
Tablo_Jhin
  • 301
  • 1
  • 3
  • 10
15
votes
1 answer

Is it possible to access Spring Documentation from Intellij IDE?

I want to view Spring Documentation via Intellj's View->Quick Documentation features. To achieve this, I have tried this following by using external documentation link: Ok, I've added the url of the Spring Framework docs. as instructed, but yet,…
mnhmilu
  • 2,327
  • 1
  • 30
  • 50
15
votes
3 answers

Allow anonymous access to springdoc-openapi-ui with Spring Security

How to allow anonymous access to springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) in a Spring Boot application secured by Spring Security?
Eugene Khyst
  • 9,236
  • 7
  • 38
  • 65
14
votes
4 answers

springdoc-openapi generate openapi yaml on build without server

I have a Spring boot Gradle project and I want to get it's OpenAPI spec YAML file. As I understand the official swagger-core does not support Spring boot projects, thus I found springdoc-openapi…
ChikChak
  • 936
  • 19
  • 44
1
2 3
…
31 32