如何在 OpenApi 中定义别名,最终在 Pojo 中使用它

Mar*_*ged 7 swagger openapi swagger-codegen openapi-generator openapi-generator-cli

假设我的 openapi.yml 中有这个定义(这只是一个虚构的示例来描述我遇到的问题):

components:
  schemas:
    Address:
      type: object
      properties:
        name:
          type: string
        zip:
          type: integer
          format: int64
        town:
          type: string
Run Code Online (Sandbox Code Playgroud)

这将导致生成如下所示的模型代码:

public class Address   {
  @JsonProperty("name")
  private String name = null;

  @JsonProperty("zip")
  private Long zip = null;

  @JsonProperty("town")
  private String town = null;
...
Run Code Online (Sandbox Code Playgroud)

我的问题是,我必须将这个 Pojo 保留在数据库中,并且不存在表Address(让我们假设它被调用Places),并且邮政编码的列被调用zipcode而不是zip.

所以我需要件事:

  • 一种告诉 OpenAPI 有关别名Address=Placeszip=zipcode.
  • 一种使此信息更改所创建的代码的方法。例如,对于 Hibernate,这意味着在正确的位置添加@Table(name="Places")和。@Column(name="zipcode")

重要提示:我无法更改 API,预计会坚持使用Addresszip

这可以做到吗?我检查了规范以及 swagger-codegen 和 openapi-generator (我更喜欢后者),但没有发现任何迹象表明类似的内容被涵盖。对于 openapi-generator,我查看了Mustache 模板,据我所知,没有代码引用 yaml 文件中定义的任何“别名信息”。

我是否必须采取艰难的方式定义一个像这样的OpenAPI 扩展,或者这样再加上自己自定义模板?我能找到的最接近的是这个现有的扩展,它定义了一种类型的别名。但这仅仅满足了我需求的第一部分。

小智 0

使用 openapi 作为别名很简单,但机器人架构很健壮。

引入AddressDto来处理公众脸(API)和内部模型之间的阻抗不匹配