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

Question

我有一个非常简单的问题:)

根据 feign 文档，它们支持通过 api 函数 like so:

传递 URI 参数来动态更改 feign 客户端对象的 basePath

好的示例：

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

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

错误示例：

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 - directory with mustache templates"，用于提供包含小胡子模板的文件夹的路径，它将采用该文件夹中的模板并覆盖现有的同名模板。

示例：

        <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 参数？

how to generate URI parameter for dynamic feign basePath using swagger codegen?

swagger

swagger-2.0

netflix-feign

feign

swagger-codegen