Как установить тип / схему OpenAPI для свойства в классе данных Kotlin - PullRequest
Новая
       100

Как установить тип / схему OpenAPI для свойства в классе данных Kotlin

1 голос
/ 13 марта 2020

В проекте Microprofile / Quarkus, использующем Kotlin, есть класс данных с переменной типа Instant. 

@Schema(name = "Vehicle", description = "POJO that represents a vehicle at a specific time.")
data class VehicleDTO(
    var time: Instant = Instant.EPOCH
)

Проблема заключается в том, что сгенерированная схема openapi не отражает значение Instant фактически передается.

Схема выглядит следующим образом, тогда как она просто представляется в виде строки: 2015-06-02T21:34:33.616Z.

Instant:
  type: object
  properties:
    nanos:
      format: int32
      type: integer
    seconds:
      format: int64
      type: integer
    epochSecond:
      format: int64
      type: integer
    nano:
      format: int32
      type: integer

Я уже пытался аннотировать класс данных, чтобы использовать строка реализации и тип string, но это ничего не меняет. 

@Schema(name = "Vehicle", description = "POJO that represents a vehicle at a specific time.")
data class VehicleDTO(
    @Schema(implementation = String::class, type = SchemaType.STRING)
    var time: Instant = Instant.EPOCH
)

1 Ответ

1 голос
/ 14 апреля 2020

Проблема в том, что классы данных получают немного особой обработки, и ваша аннотация помещается в аргумент конструктора .

Это можно увидеть в сгенерированном байт-коде вашего класса данных. Соответствующий фрагмент: 

@Schema(
   name = "Vehicle",
   description = "POJO that represents a vehicle at a specific time."
)
@Metadata(...)
public final class VehicleDTO {
   @NotNull
   private Instant time;

   @NotNull
   public final Instant getTime() {
      return this.time;
   }

   public final void setTime(@NotNull Instant var1) {
      Intrinsics.checkParameterIsNotNull(var1, "<set-?>");
      this.time = var1;
   }

   public VehicleDTO(@Schema(implementation = String.class,type = SchemaType.STRING) @NotNull Instant time) {
      Intrinsics.checkParameterIsNotNull(time, "time");
      super();
      this.time = time;
   }

   // ...
}

Вам нужно указать Kotlin, чтобы разместить его на поле, используя цель использования сайта : 

@Schema(name = "Vehicle", description = "POJO that represents a vehicle at a specific time.")
data class VehicleDTO(
    @field:Schema(implementation = String::class, type = SchemaType.STRING)
    var time: Instant = Instant.EPOCH
)

Соответствующий байт-код впоследствии : 

@Schema(
   name = "Vehicle",
   description = "POJO that represents a vehicle at a specific time."
)
@Metadata(...)
public final class VehicleDTO {
   @Schema(
      implementation = String.class,
      type = SchemaType.STRING
   )
   @NotNull
   private Instant time;

   @NotNull
   public final Instant getTime() {
      return this.time;
   }

   public final void setTime(@NotNull Instant var1) {
      Intrinsics.checkParameterIsNotNull(var1, "<set-?>");
      this.time = var1;
   }

   public VehicleDTO(@NotNull Instant time) {
      Intrinsics.checkParameterIsNotNull(time, "time");
      super();
      this.time = time;
   }

   // ...
}
...