是否可以向 OpenAPI 添加方法？

Question

我有一個問題：是否可以將具有某些邏輯的方法添加到由 open-api 生成的 DTO。

例如我有一個 openapi DTO：

CarDTO:
   type: object
   properties:
     id:
       type: string
       format: uuid
     isEngineWorks:
       type: boolean
       default: false
     isFuelFull:
       type: boolean
       default: false

我使用 maven 插件（openapi-generator-maven-plugin），它為我生成了一個 java 類：

public class CarDTO {
    @JsonProperty("id")
    @Valid
    private UUID id;

    @JsonProperty("isEngineWorks")
    private Boolean isEngineWorks = false;

    @JsonProperty("isFuelFull")
    private Boolean isFuelFull = false;
}

是否可以在openapi中添加一個方法，所以它將在我的DTO中生成？ 結果，我想要：

public class CarDTO {
    @JsonProperty("id")
    @Valid
    private UUID id;

    @JsonProperty("isEngineWorks")
    private Boolean isEngineWorks = false;

    @JsonProperty("isFuelFull")
    private Boolean isFuelFull = false;
    
    public boolean isCarReadyToDrive {
        return isEngineWorks && isFuelFull;  
    }

}

Answer 1

當然，這是可能的。

您必須覆蓋與您正在使用的 OpenAPI 生成器相關的pojo.mustache文件。

我通常會這樣做，這里是官方的 OpenAPI 定制指南。