Questions tagged [springdoc-openapi-maven-plugin]
14 questions
5
votes
2 answers
How to tell springdoc-openapi-maven-plugin to generate YAML instead of JSON?
I am using the springdoc-maven-openapi-plugin this way:
org.springdoc
springdoc-openapi-maven-plugin
1.1
…

du-it
- 2,561
- 8
- 42
- 80
4
votes
0 answers
How can I integrate POM build version into YAML generation using springdoc-openapi-maven-plugin?
Is there a way to programmatically set the build version from the POM of my Spring Boot application into the OpenApi YAML generated by the springdoc-openapi-maven-plugin?
How can I achieve it?
Currently I have integrated the…

du-it
- 2,561
- 8
- 42
- 80
3
votes
2 answers
How to generate an OpenAPI from a Spring app without running the app?
I can run a Spring Boot application and then use the springdoc-openapi-maven-plugin artifact to generate an OpenAPI spec.
However, is there also a way to generate the spec without running the application first?
I currently want to generate the spec…

Lukas
- 381
- 3
- 13
3
votes
0 answers
Order Springdoc operation parameters alphabetically
Migrating from springfox - springdoc
springfox generated an openApi definition that ordered all the parameters in alphabetical order, I've migrated to springdoc, but have been unable to find a way to keep the springfox ordering(alpha) of the…

JTK
- 1,469
- 2
- 22
- 39
1
vote
1 answer
springdoc-openapi-maven-plugin adding example at null in YAML file
I'm using springdoc-openapi-maven-plugin to generate a contract in YAML format and somehow it generates an example at null (example: null) for each path/request parameter.
Is there a way to avoid that ?
Here is an example of the generated…

Fred
- 741
- 2
- 10
- 22
1
vote
0 answers
swagger-codegen-maven-plugin v3 issues
We are migrating from springfox 2.0 to openAPI 3.0. The client generation plugin has two challenges -
The APIs which are acceping formdata, having consumes = "application/x-www-form-urlencoded" are getting converted into queryParams. Following is…

Vishal_Kotecha
- 481
- 5
- 19
0
votes
0 answers
SpringDoc Maven Plugin to generate OpenAPI
Trying to generate OpenAPI documentation using the springdoc-openapi-maven-plugin.
https://springdoc.org/#plugins
I added the springdoc-openapi-maven-plugin configuration exactly as suggested in the documentation.
I already had the…

DJViking
- 832
- 1
- 12
- 29
0
votes
1 answer
springdoc-openapi-maven-plugin: runtime or build time?
I have a SpringBoot project and want to generate openapi doc (json or yaml) at runtime.
For that I wanted to use the springdoc-openapi-maven-plugin, since the documenation states that
The aim of springdoc-openapi-maven-plugin is to generate json…

Julien Berthoud
- 721
- 8
- 24
0
votes
0 answers
Generate OpenApi 3 with annotation SpringBoot v3
I'm trying to generate a file openapi.yaml with the correct annotation and with the "springdoc-openapi-maven-plugin:1.4"
The project is structured in a hexagonal architecture ande the dependency and plugin are on a submodule of rest package.
I have…

Sergio Antonio Snchez Camarero
- 389
- 4
- 18
0
votes
1 answer
issue with generating a document using springdoc-openapi-maven-plugin during the build process of the project
I'm using the springdoc-openapi-maven-plugin to generate a document_name.json file during the mvn clean install command, with the following plugin configuration:
org.springdoc
…

Zahir Basha
- 1
- 2
0
votes
0 answers
springdoc-openapi-maven-plugin and custom-annotations
Is there a way to generate an OpenAPI spec from Java code with the springdoc-openapi-maven-plugin, which also contains custom annotations? How do I make the custom annotations known to the plugin?

BugHunter
- 1
- 1
0
votes
1 answer
How to force springdoc-maven-openapi-plugin to generate YAML file?
This is a similar question to this one on the same subject.
I have actually managed to generate a YAML file successfully using the solution for the answer above. Suddenly, when I was going to demo to my peers, the generated file was JSON.
The code…

gtludwig
- 5,411
- 10
- 64
- 90
0
votes
1 answer
How to skip @DateTimeFormat annotation in open-api-generator plugin
I am trying to generate interface from yaml file using open api generator plugin. However while generating the interface an additional annotation @DateTimeFormatter is getting added for date field. Can someone help how to skip adding this…

user3212324
- 163
- 1
- 6
- 23
0
votes
1 answer
springdoc-openapi-maven-plugin configuration isn't applied
I'm currently testing springdoc to integrate it in other projects. I found out, that the maven plugin doesn't apply any configuration settings, e.g. the outputfilename can't be set. If I'm calling mvn verify, the plugin just generates…

Thilo Schwarz
- 640
- 5
- 24