swagger-codegen 客户端：如何在模型上包含 jackson 注释

Question

我正在使用 swagger-codegen 生成一个 rest 客户端，但是我遇到了一个问题，我正在使用的服务返回一个带有继承的模型，API 模型如下所示：

public class Person
{
    private List<Book> books;
    ...
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "typeClass")
@JsonSubTypes({ @JsonSubTypes.Type(value = Magazine.class) })
public class Book 
{
    //some prop
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "typeClass")
public class Magazine extends Book
{
    //some prop
}

API 模型使用 jackson 注解进行注解以处理继承。 API 工作正常。 当我生成客户端时，客户端模型没有jackson注解，所以当我使用生成的客户端消费API时，它总是使用Book类进行反序列化。 它不会“看到” Magazine 类。 我认为这是因为生成的模型没有处理继承的 jackson 注释。

如何配置 swagger-codegen 以将 jackson 注释添加到模型中。

非常感谢...

Answer 1

而不是使用

    java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate 
   -i http://petstore.swagger.io/v2/swagger.json   
    -l java
    -o samples/client/petstore/java

你可以和

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate 
-i http://petstore.swagger.io/v2/swagger.json   
-l spring
-o samples/client/petstore/java

通过语言更改，他们还将 gson 换成了 Jackson。

在你的情况下，你会有类似的东西

import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.model.Category;
import io.swagger.model.Tag;
import java.util.ArrayList;
import java.util.List;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.*;

/**
 * Pet
 */
@Validated
@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2020-06-04T13:33:18.844+02:00")




public class Pet   {
  @JsonProperty("id")
  private Long id = null;

  @JsonProperty("category")
  private Category category = null;

  @JsonProperty("name")
  private String name = null;

  @JsonProperty("photoUrls")
  @Valid
  private List<String> photoUrls = new ArrayList<String>();

  @JsonProperty("tags")
  @Valid
  private List<Tag> tags = null;
      ...

来源： https : //github.com/swagger-api/swagger-codegen/issues/5785

当您使用 Generator.Swagger（ https://generator.swagger.io/在线 swagger Codegen api:/gen/clients/{language}）构建客户端时，您可以查看 /gen/clients/{language} 中的设置或https://openapi-generator.tech/docs/generators/java/并建立您的请求。

Answer 2

在 pom.xml 的插件配置中添加以下代码行

<'library>$libraryValue<'/library>

$libraryValue 可以基于您在依赖项中使用的库。 如果您使用的是 Jersey 1.xx 或者 jersey2 如果您使用的是 Jersey 2.xx

感谢https://stackoverflow.com/users/3695939/moondaisy为您提供的先机。