Question

我有一个非常简单的问题：）

根据feign文档，他们支持通过api函数like so传递URI参数来动态更改假装客户端对象的basePath：

好示例：

interface MyClient {
    @RequestLine("GET /internal-service")
    String internalService(URI baseUrl);
}

问题是我正在使用swagger，他从yaml文件生成我的API并在所有函数参数中添加@Param注释，这对我不利。

BAD示例：

interface MyClient {
    @RequestLine("GET {baseUrl}/internal-service")
    String internalService(@Param("baseUrl") String host);
}

有没有办法让swagger生成器生成带有URI参数的API，而没有@Param注释？

期望的结果示例：

interface MyClient {
    @RequestLine("POST /internal-service")
    String internalService(URI baseUrl, @Param("someParam") String someParam);
}

Answer 1

初步解决方案：

经过一番调查后，我意识到swagger-codegen 2.2.3中没有支持生成URI参数作为客户端API函数的一部分。

但swagger-codegen-maven-plugin配置中有一个选项 “templateDirectory - 带有胡子模板的目录”，用于提供包含胡子模板的文件夹的路径，该模板将获取该文件夹中的模板并覆盖具有相同名称的现有模板。

示例：

<plugin> <groupId>io.swagger</groupId> <artifactId>swagger-codegen-maven-plugin</artifactId> <executions> <execution> <id>my-project-api-client-kit</id> <goals> <goal>generate</goal> </goals> <configuration> <inputSpec>${project.build.directory}/my-project-api.yaml</inputSpec> <language>java</language> <configOptions> <dateLibrary>java8</dateLibrary> <sourceFolder>src/main/java</sourceFolder> </configOptions> <modelPackage>my.project.ck.resources.models</modelPackage> <apiPackage>my.project.ck.resources.interfaces</apiPackage> <library>feign</library> <templateDirectory>/myTemplateFolder/</templateDirectory> </configuration> </execution> </executions> </plugin>

在自定义模板文件夹中，将您自己的api.mustache文件与附加的“URI basePath”参数放在一起：

... {{#returnType}}{{{returnType}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{nickname}}(URI basePath, {{#allParams}}{{^isBodyParam}}{{^legacyDates}}@Param("{{paramName}}") {{/legacyDates}}{{#legacyDates}}@Param(value="{{paramName}}", expander=ParamExpander.class) {{/legacyDates}}{{/isBodyParam}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); ...

注意： Swagger提供了许多用于各种用途的模板，请确保根据您使用的模板获取和修改正确的api.mustache模板文件。在上面的例子中，我修改（并覆盖）java.libraries.feign / api.mustache文件，因为这是我的插件配置的文件（如示例中所示）。

如何使用swagger codegen为动态feign basePath生成URI参数？

1 个答案: