更改Spring openapi生成器插件生成接口的返回类型

Question

我已经成功地从一个。yaml打开api描述符文件，但正如问题标题中所述，我希望将这些接口的响应类型从ResponseEntity更改为我自己的类型。基本上，接口没有此签名：

 ResponseEntity<Void> clearCache();

对于基本上以这种方式实现的方法：

public void clearCache(){ //do something}

我希望生成的接口尽可能简单

void clearCache();

同样的事情，我自己定义的类，而不是响应实体

        <plugin>
            <groupId>org.openapitools</groupId>
            <artifactId>openapi-generator-maven-plugin</artifactId>
            <version>4.3.0</version>
            <executions>
                <execution>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <configuration>
                        <inputSpec>my-own-service-be/src/main/resources/api-docs.yaml</inputSpec>
                        <generatorName>spring</generatorName>
                        <additionalProperties>
                             <additionalProperty>skipDefaultInterface=true</additionalProperty>
                            <additionalProperty>interfaceOnly=true</additionalProperty>
                        </additionalProperties>
                        <generateApis>true</generateApis>
                        <apiPackage>controller</apiPackage>
                        <supportingFilesToGenerate>false</supportingFilesToGenerate>
                        <modelPackage>dto</modelPackage>
                        <generateModelTests>false</generateModelTests>
                        <generateApiTests>false</generateApiTests>
                    </configuration>
                </execution>
            </executions>
        </plugin>




Answer 1

菲洛诺斯的回答是朝着好的方向迈出了一步。可以在这里找到Spring Boot的所有模板。但仅仅更改“api.mustache”是不够的，因为“api.mustache”不包含默认方法实现的模板。您必须禁用默认方法实现的生成，或者为其更改模板。

如前所述，您必须在pom中指定模板目录。xml:

<configuration>
 <templateDirectory>${project.basedir}/src/main/resources/custom</templateDirectory>
 <skipDefaultInterface>true</skipDefaultInterface>

步骤1-api.mustache：

此处删除“import org.springframework.http.ResponseEntity；”，只是为了确保它不再被使用。然后通过替换“ResponseEntity”从返回类型中删除ResponseEntity

步骤2-禁用默认方法生成或更改方法Body.mustache：

使用“skipDefaultInterface”选项禁用默认实现的生成（如pom.xml中所示）。否则，编辑“methodBody.mustache”在“returnnewresponseEntity”前面添加“抛出新的IllegalArgumentException（“未实现”）；/”

Answer 2

我不知道你为什么要那样做。您可以简单地将ResponseEntity想象为您的类型的包装器，增加了处理标准HTTP特性（如HTTP状态代码和头）的可能性。有关更多详细信息，请参见此处。在你的情况下，你只会这样做

ResponseEntity.noContent().build(); //void

ResponseEntity.ok(myBook) //to return your MyBook type

Answer 3

我们最近遇到了类似的挑战。您需要做的是调整模板。为此，您需要从OpenAPI项目中找到生成器的源模板。这就是api。胡须文件在您的案例中。

只需将其复制到您的src/main/resources/文件夹（可能位于名为custom的子文件夹中），并根据您的需要进行调整，即更换响应类型。

然后您需要调整pom。xml，以便实际使用自定义模板文件：

     <configuration>

        <!-- The following line is crucial: -->
        <templateDirectory>${project.basedir}/src/main/resources/custom</templateDirectory>

        <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
        <generatorName>spring</generatorName>
        <configOptions>
            <sourceFolder>src/gen/java/main</sourceFolder>
        </configOptions>
    </configuration>

还可以查看此模板文档，以了解有关此主题的更多信息。