Skip to content
GitLab

[JAVA] new Feature interface: Documentation Provider and Annotation Library

Merged Administrator requested to merge github/fork/cachescrubber/feature/documentation_provider_pr into master

Created by: cachescrubber

This PR introduces two new additional properties for all Java Based CodegenConfigs (extending AbstractJavaCodegen). The Properties are defined by a new Features interface, org.openapitools.codegen.languages.features.DocumentationProviderFeatures.

Synopsis

--additional-properties documentationProvider=springdoc,annotationLibrary=swagger2

When a documentation provider and annotation library are selected, a boolean property is added to the codegen model. For example, when SpringDoc is the selected as a documentation provider, the following properties are available in the mustache templates.

documentationProvider: springdoc
springDocDocumentationProvider: true
annotationLibrary: swagger2
swagger2AnnotationLibrary: true

The Documentation Provider and Annotation Libraries are defined in a dedicated Enum each.

My main goal is to define the property names used in the templates in a central location and to avoid having a dozen of different additional property names and semantics in the various Java based CodegenConfigs.

The SpringCodegen serves as a demo of how to integrate into other Java based CodegenConfigs.

Naming is hard. The propertyNames and Annotation Values where not easy. Specially Swagger1 and Swagger2 are based on the version numbers of their release artifacts, not using the target OAS specifiction version. Anyway, since the are defined in the Enums they are pretty easy to change in the current stage. Feel free to come up with suggestions and an alternative nameing.

Relates To

#8801 #9775 #11181

PR checklist

  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [x ] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.