如何用Swagger自动生成带Netflix Feign注解的客户端接口？

当然可以！Swagger Codegen其实支持生成原生Netflix Feign注解的客户端接口，只是需要调整生成配置来指定使用Netflix的Feign注解，而不是默认的OpenFeign扩展。下面是具体的实现步骤：

1. 用命令行快速生成验证 #

如果你用Swagger Codegen的CLI工具，只需要指定正确的参数就能生成符合要求的接口。示例命令如下：

java -jar swagger-codegen-cli.jar generate \
  -i [你的Swagger JSON/YAML文件路径或在线URL] \
  -l java \
  -o ./generated-feign-client \
  --additional-properties \
    feign=true,\
    feignClientAnnotationPackage=org.springframework.cloud.netflix.feign,\
    interfaceOnly=true,\
    library=feign

参数说明：

• feign=true: 开启Feign客户端生成模式
• feignClientAnnotationPackage: 指定使用Spring Cloud Netflix Feign的@FeignClient注解（对应包路径org.springframework.cloud.netflix.feign）
• interfaceOnly=true: 只生成接口类，不生成多余的实现代码，完全匹配你的需求
• library=feign: 明确指定使用Feign作为底层客户端库

2. 集成到Maven/Gradle构建流程 #

如果需要在项目构建中自动生成代码，以Maven为例，配置Swagger Codegen插件如下：

<plugin>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-codegen-maven-plugin</artifactId>
  <version>2.4.32</version> <!-- 建议使用稳定版本 -->
  <executions>
    <execution>
      <goals>
        <goal>generate</goal>
      </goals>
      <configuration>
        <inputSpec>${project.basedir}/src/main/resources/your-swagger-spec.json</inputSpec>
        <language>java</language>
        <output>${project.build.directory}/generated-sources/swagger</output>
        <additionalProperties>
          <feign>true</feign>
          <feignClientAnnotationPackage>org.springframework.cloud.netflix.feign</feignClientAnnotationPackage>
          <interfaceOnly>true</interfaceOnly>
          <library>feign</library>
        </additionalProperties>
      </configuration>
    </execution>
  </executions>
</plugin>

执行mvn generate-sources命令，就能自动将代码生成到指定目录。

3. 生成代码示例 #

生成后的接口会和你给出的示例几乎一致，比如：

@FeignClient(name = "ldap-proxy")
public interface LdapProxyClient {
    @RequestMapping(path = "/ldap-proxy/v1/users/{userNameOrEMail}", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET)
    LdapUser search(@PathVariable("userNameOrEMail") String userNameOrEMail);
}

几个注意事项 #

• 确保你的项目依赖了Spring Cloud Netflix Feign，比如Maven中添加：

  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
    <version>1.4.7.RELEASE</version> <!-- 根据你的Spring Cloud版本调整 -->
  </dependency>
  

• 不同版本的Swagger Codegen参数可能略有差异，如果遇到问题，可以查看对应版本的官方文档确认参数细节
• 如果你的Swagger规范中有复杂的请求参数或响应模型，可能需要调整modelPackage等参数来规范生成代码的包结构

内容的提问来源于stack exchange，提问作者Μenelaοs