Skip to content
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

[java][spring] added springdoc support for service metadata and security #12346

Merged
merged 13 commits into from
May 18, 2022

Conversation

bluenick2k17
Copy link
Contributor

  • Added the auto-generated OpenAPI 3 support for service metadata and security, using springdoc.
    • Changes made to SpringCodegen to add the new documentation config file (SpringDocConfiguration.java) to the list of auto-generated files
    • Added new template file: springdocDocumentationProvider.mustache for the Spring generator which builds SpringDocConfiguration.java
    • This can be validated by generating a java spring API using the default documentation provider, and examining target/generated-sources/openapi/src/main/java/org/openapitools/configuration/SpringDocConfiguration.java in the resulting API.
    • Updated spring samples in this PR can also be checked to see some examples of the new springdoc configuration files.
  • CodegenSecurityTest was updated to test the new addition of the SpringDoc configuration, and test was cleaned up to reduce duplication when adding the additional documentation provider test.
  • Fixed a piece of documentation and the connected code in SpringCodegen which still used Springfox verbiage, even though the default documentation provider is springdoc.

Some notes on the implementation:

  • Did not remove Springfox, since it's marked for removal in 7.0.0: [Announcement] Deprecation Warnings for the Java/Spring Generator #11553
  • Current pull request supports basic and API key fully with the security info. Does not yet support Oauth2 completely since it would require a bunch more work into the template. Would affect the ability to use auth on the swagger-ui with Oauth2
  • CodegenSecurity doesn't support a description field yet for the auth method, so as of now that support remains the same

Closes #12220

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02)

@bluenick2k17 bluenick2k17 changed the title Spring add springdoc config [java][spring] added springdoc support for service metadata and security May 13, 2022
Copy link
Contributor

@welshm welshm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this!

@wing328 wing328 added this to the 6.0.0 milestone May 18, 2022
@wing328 wing328 merged commit d38cb1b into OpenAPITools:master May 18, 2022
@wing328
Copy link
Member

wing328 commented May 28, 2022

Thanks again for the PR, which has been included in the v6.0.0 release: https://twitter.com/oas_generator/status/1529669733934841856

@bluenick2k17 bluenick2k17 deleted the spring-add-springdoc-config branch November 27, 2022 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ][JAVA][SPRING] Adding springdoc-openapi support for service metadata and security
5 participants