Questions tagged [springdoc-openapi-ui]

365 questions
0
votes
1 answer

OpenApi Spec - What is the best practice that multiple microservices use the same schema (data model)

OpenApi Spec - What is the best practice that multiple microservices use the same components schema (data model) ? Example: Microservice1 api spec: responses: $ref: '#/components/schemas/MyResponse' components: schemas: MyResponse: …
Shashank
  • 712
  • 15
  • 33
0
votes
1 answer

Swagger OpenAPI UI sending 403 response status for POST, PUT and DELETE Requests : Server hosted behind Nginx Proxy

Issue : Get request for Swagger UI openAPI is working , whereas other method types giving 403 error. Dependency : org.springdoc springdoc-openapi-ui
0
votes
0 answers

Spring doc oauth2RedirectUrl with wrong server

I'm writing my first question, please be patient if anything is missing. Any Feedback is welcome. We have an issue with the generated oauth2RedirectUrl after migrating from a Windows 2012 R2 to a Windows 2016. The server is no longer containing the…
Andli
  • 1
  • 1
0
votes
1 answer

How to expose open-API endpoint in spring cloud and azure application

I am trying to use open API in spring cloud and Microsoft azure functions but I am unable to expose the open API URL. In the console (attached image), you can see I have only one api endpoint which is referring to my spring cloud and azure function.…
0
votes
1 answer

Which version of spring doc open ui gradle plugin be used with spring-boot 2.6?

Which version of spring doc open ui gradle plugin be used with spring-boot 2.6 ? I see this is the last plugin id "org.springdoc.openapi-gradle-plugin" version "1.3.3" which si not compatable with spring-boot 2.6
0
votes
0 answers

Why springdoc swagger-ui returns page with empty array []?

When I run locally my Spring Boot application with added dependencies springdoc-openapi-ui, I expect to get generated swagger api form for rest methods at url http://localhost:55555/swagger-ui/index.html, but instead I get response with empty array…
WeGa
  • 801
  • 4
  • 10
  • 24
0
votes
0 answers

How to programmatically include a custom property into spec generated by springdoc-openapi?

I have an endpoint that accepts and sends back objects of the form {a: 1, b: 2, c:3} where either b or c is missing. To precise, admissible objects are {a: 1, b: 2}, {a: 1, c:3} where the values are free to…
peer
  • 4,171
  • 8
  • 42
  • 73
0
votes
1 answer

Springdoc openapi 3 @Schema example ignored

@Schema Example is ignored by springdoc Openapi on one class property, but working on other property in the same class. Added @Schema(type = "integer", format = "int64", example = "1560868939063") private Instant date; on a field of a…
Daniel Jeney
  • 486
  • 1
  • 5
  • 19
0
votes
1 answer

springdoc swagger ui not showing entity component model schema

org.springdoc-openapi-ui version = 1.5.13 using Maven 4.0.0, java 11 model user.java @Entity(name = "User") @Table(name = "User") public class User { @Id @GeneratedValue(strategy=GenerationType.AUTO) private Integer id; @Column …
eln
  • 63
  • 3
  • 12
0
votes
0 answers

Swagger UI conditionally hide endpoint based on environment

i would like to conditionally hide an endpoint i put in just for dev and test environments but i am having trouble... @Value("${spring.profiles.active}") String deployEnv; @Profile("!prod") @io.swagger.v3.oas.annotations.Operation(summary="this is…
user2052618
  • 556
  • 2
  • 7
  • 20
0
votes
1 answer

springfox to springdoc-openapi-ui migration

I have a spring mvc I am migrating from springfox to springdoc swagger I have followed the steps mentioned in this link, but when I try to access the swagger page, it gives me below error no mapping found for http request with url…
0
votes
1 answer

Open API documentation of Springboot based REST apis fail with ApplicationContextException. The project is built with gradlew shadow plugins

I am trying to add open api documentation to springboot base REST api project that I have. It works fine when run locally inside intelliJ IDE or with gradlew run/bootRun But when the project is packaged as a fat jar using gradlew shadow plugin…
0
votes
1 answer

OpenApi/Swagger with Spring boot integration issue

I am trying to integrate openApi with swagger in my spring boot application. The swagger UI loads, however it is not finding the swaggerjson file it needs to render the page. I added the below dependencies:
0
votes
1 answer

springdoc swagger-ui redirect not including hostname

When I hit the swagger-ui url I am redirected to a link with the configUrl appended. But the new url doesn't include the scheme, hostname or port. Is there a setting that I am missing? Current…
0
votes
1 answer

springdoc-openapi-ui not compatible with openapi-generator-maven-plugin

I started out with an openapi specification (3.0.1) design and generated the code with the openapi-generator-maven-plugin (5.1.0) then I used the springdoc-openapi-ui for spring boot (2.5.4). I needed to manually migrate most of the annotations in…
1174
  • 131
  • 2
  • 16