Springfox Swagger生成创建奇怪的模式

时间:2017-01-16 11:32:50

标签: java jackson swagger swagger-ui springfox

我正在使用Springfox-swagger为我的Spring Boot REST服务生成一个Swagger页面。作为我序列化为JSON的一个POJO的一部分,我使用:

  • javax.money.MonetaryAmount
  • java.time.LocalDate

我看到的问题是,在Swagger中,响应的Model和Model Shema选项卡显示了这些字段的实现细节,即

LocalDate {
 chronology (IsoChronology, optional),
 dayOfMonth (integer, optional),
 dayOfWeek (string, optional) = ['MONDAY' or 'TUESDAY' or 'WEDNESDAY' or 'THURSDAY' or 'FRIDAY' or 'SATURDAY' or 'SUNDAY'],
 dayOfYear (integer, optional),
 era (Era, optional),
 leapYear (boolean, optional),
 month (string, optional) = ['JANUARY' or 'FEBRUARY' or 'MARCH' or 'APRIL' or 'MAY' or 'JUNE' or 'JULY' or 'AUGUST' or 'SEPTEMBER' or 'OCTOBER' or 'NOVEMBER' or 'DECEMBER'],
 monthValue (integer, optional),
 year (integer, optional)
}
IsoChronology {
  calendarType (string, optional),
  id (string, optional)
}
Era {
  value (integer, optional)
}

MonetaryAmount {
  context (MonetaryContext, optional),
  currency (CurrencyUnit, optional),
  factory (MonetaryAmountFactory«MonetaryAmount», optional),
  negative (boolean, optional),
  negativeOrZero (boolean, optional),
  number (NumberValue, optional),
  positive (boolean, optional),
  positiveOrZero (boolean, optional),
  zero (boolean, optional)
}
MonetaryContext {
  (...)
}
CurrencyUnit {
  (...)
}
CurrencyContext {
  (...)
}
MonetaryAmountFactory«MonetaryAmount» {
  (...)
}
NumberValue {
  (...)
}

如果重要的话,我正在使用javax.money.MonetaryAmount(JSR 354)的Moneta 1.1实现。

现在,这对于我想要的东西来说已经足够了,所以我实现了一个Serialiser,我的响应(和请求)按预期工作。但是,架构并未反映出这一点。在序列化请求后是否有一种配置模式格式的方法?

正如我意识到这个问题有很多可动的部分,我已经创建了一个proof of concept project来充分展示这个问题。

1 个答案:

答案 0 :(得分:3)

基于your example看起来您在序列化工具中将MonetaryAmount转换为doubleLocalDate转换为String

因为springfox无法反省杰克逊机器(至少还没有:-)),我们需要告诉SpringFox你在序列化器中做了什么。为此,如您的文档中的the documentation所述,您可以通过提供替代类型规则来提供提示。

docket
      .directModelSubstitute(LocalDate.class, String.class)
      .directModelSubstitute(MonetaryAmount.class, Double.class)

有三种方法可以执行此操作,通过directModelSubstitutes表示常规类型,genericModelSubstitutes表示单一类型参数泛型类型,alternateTypeRules表示更复杂的泛型类型用例。