Skip to content

[Feature] Pretty print OpenApi spec #703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dominic-jones opened this issue May 27, 2020 · 1 comment
Closed

[Feature] Pretty print OpenApi spec #703

dominic-jones opened this issue May 27, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@dominic-jones
Copy link

Is your feature request related to a problem? Please describe.
This maven plugin is useful for creating an offline representation of the OpenApi specification.
It can be useful to check in the generated spec to diff it in pull requests when the api changes.
However, it is not formatted, and is difficult for humans to read as generated.

Describe the solution you'd like
I would like a pretty-printed output of the OpenApi specification.

Describe alternatives you've considered
This could be behind a configuration to pretty print if desired.

@bnasslahsen bnasslahsen transferred this issue from springdoc/springdoc-openapi-maven-plugin May 30, 2020
@bnasslahsen
Copy link
Collaborator

@dominic-jones,

This feature will be available with the next release. v1.4.1.
You can use with the springdoc-openapi-maven plugin, by adding the following command line arguement:

-Dspring-boot.run.arguments=--springdoc.writer-with-default-pretty-printer=true

@bnasslahsen bnasslahsen added the enhancement New feature or request label Jan 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants