[java-spring] - library spring-http-interface create swagger annotations if not explicitly configured to not do

[atokle]

When using spring generator with library=spring-http-interface it generates client code that should not have swagger annotations. But it's created anyaway, and without imports, so they wont even compile.

The implementation for this was trying to set documentationProvider and annotationLibrary to none but got a bug, so additionalParameters already got values set for documentationProvider and annotationLibrary unless you specifically configure documentationProvider=none and annotationLibrary=none

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 || exit
  ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
  ./bin/utils/export_docs_generators.sh || exit
  

  (For Windows users, please run the script in WSL)
  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*.
  IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
• File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
• If your PR solves a reported issue, reference it using [GitHub's linking syntax] "fixes [BUG][spring-http-interface]Missing Import when using spring-http-interface #15631"
• 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) @Zomzog (2022/09) @martin-mfg (2023/08)

---

Summary by cubic

Stop generating Swagger/SpringDoc annotations for Spring HTTP Interface to prevent compile errors. Forces docs/annotations to NONE, ignores user config, and defaults to Jakarta EE for this library.

• Bug Fixes

  • Clear documentationProvider and annotationLibrary from additionalProperties and set both to NONE for library=spring-http-interface.
  • Safely disable Swagger UI by comparing documentationProvider to NONE to avoid NPE.
  • Add a test ensuring PetApi has no @parameter annotations even when annotationLibrary=SWAGGER2 and documentationProvider=SPRINGDOC.

• Migration

  • No changes required; any annotationLibrary or documentationProvider you set will be ignored for this library.

^{Written for commit 652a20d. Summary will update on new commits.}

[cubic-dev-ai]

No issues found across 2 files

[wing328]

But it's created anyaway, and without imports, so they wont even compile.

Thanks for the PR.

I did a test with the following and the output compiles:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring --library spring-http-interface -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring/

Am I repeating the issue correctly?

[atokle]

But it's created anyaway, and without imports, so they wont even compile.

Thanks for the PR.

I did a test with the following and the output compiles:

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g spring --library spring-http-interface -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/spring/

Am I repeating the issue correctly?

Thank you for following up @wing328

I have only used the generator from maven plugin. I tried to recreate the error from the CLI without success.

If you create a maven project with this pom and run mvn compile, you will get the error. The workaround is to uncomment the two lines commented out.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>TestOpenapiGeneratorMaven</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>25</maven.compiler.source>
        <maven.compiler.target>25</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <openapi-generator-maven-plugin.version>7.20.0</openapi-generator-maven-plugin.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>4.0.3</version>
        </dependency>
        <dependency>
            <groupId>jakarta.validation</groupId>
            <artifactId>jakarta.validation-api</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.swagger.core.v3</groupId>
            <artifactId>swagger-annotations</artifactId>
            <version>2.2.37</version>
        </dependency>
        <dependency>
            <groupId>org.openapitools</groupId>
            <artifactId>openapi-generator-maven-plugin</artifactId>
            <version>${openapi-generator-maven-plugin.version}</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.openapitools</groupId>
                <artifactId>openapi-generator-maven-plugin</artifactId>
                <version>${openapi-generator-maven-plugin.version}</version>
                <executions>
                    <execution>
                        <id>Petstore</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <configuration>
                            <inputSpec>${project.baseUri}/src/main/resources/3_0/petstore-echo.yaml</inputSpec>
                            <generateApiTests>false</generateApiTests>
                            <generateModelTests>false</generateModelTests>
                            <generatorName>spring</generatorName>
                            <configOptions>
                                <library>spring-http-interface</library>
                                <dateLibrary>java8</dateLibrary>
                                <useTags>true</useTags>
                                <modelNameSuffix>Dto</modelNameSuffix>
                                <useSpringBoot4>true</useSpringBoot4>
                                <useJackson3>true</useJackson3>
                                <openApiNullable>false</openApiNullable>
<!--                                <annotationLibrary>none</annotationLibrary>-->
<!--                                <documentationProvider>none</documentationProvider>-->
                            </configOptions>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

[Picazsoo]

I remember this being problematic also when used with the gradle plugin.

[Chrimle]

Looks great ❤️

it matches what the docs say about the annotationLibrary:

openapi-generator/docs/generators/spring.md

Line 26 in 9afa74a

|annotationLibrary|Select the complementary documentation annotation library.|<dl><dt>**none**</dt><dd>Do not annotate Model and Api with complementary annotations.</dd><dt>**swagger1**</dt><dd>Annotate Model and Api using the Swagger Annotations 1.x library.</dd><dt>**swagger2**</dt><dd>Annotate Model and Api using the Swagger Annotations 2.x library.</dd></dl>|swagger2|

as well as about documentationProvider:

openapi-generator/docs/generators/spring.md

Line 51 in 9afa74a

|documentationProvider|Select the OpenAPI documentation provider.|<dl><dt>**none**</dt><dd>Do not publish an OpenAPI specification.</dd><dt>**source**</dt><dd>Publish the original input OpenAPI specification.</dd><dt>**springfox**</dt><dd>Generate an OpenAPI 2 (fka Swagger RESTful API Documentation Specification) specification using SpringFox 2.x. Deprecated (for removal); use springdoc instead.</dd><dt>**springdoc**</dt><dd>Generate an OpenAPI 3 specification using SpringDoc.</dd></dl>|springdoc|

[wing328]

I have only used the generator from maven plugin. I tried to recreate the error from the CLI without success.

using the plugin, i could repeat the issue and confirmed the fix