我们正在使用Spring Web MVC 3.2.2和Jackson Databind 2.4.4(还有许多其他库...)来开发相当大的JSON REST API。
我正在尝试使用swagger-springmvc,但是我的一些DTO遇到了麻烦。
无论我使用简单的@EnableSwagger
还是更复杂的swagger配置,启动Tomcat 7时总是会收到以下异常:
java.lang.IllegalArgumentException: Conflicting setter definitions for property "year": javax.xml.datatype.XMLGregorianCalendar#setYear(1 params) vs javax.xml.datatype.XMLGregorianCalendar#setYear(1 params)
at com.fasterxml.jackson.databind.introspect.POJOPropertyBuilder.getSetter(POJOPropertyBuilder.java:303)
at com.mangofactory.swagger.models.Annotations.findPropertyAnnotation(Annotations.java:33)
at com.mangofactory.swagger.models.property.bean.BeanModelProperty.<init>(BeanModelProperty.java:26)
at com.mangofactory.swagger.models.property.bean.BeanModelPropertyProvider.beanModelProperty(BeanModelPropertyProvider.java:166) (...rest of stacktrace )
上面提到的属性“year”只是一个示例,在没有包含属性year的类的情况下尝试了相同的示例。
奇怪的是, jackson 接缝两次找到相同的确切方法/设置器:
javax.xml.datatype.XMLGregorianCalendar#setYear(1 params)
和javax.xml.datatype.XMLGregorianCalendar#setYear(1 params
我花了一些时间在调试器上,发现一些DTO似乎通过了对设置程序冲突的检查。
我现在已经花了很多时间来解决这个问题。我在Google上发现的有关此异常的大多数页面都谈论重载的方法/设置器,而我的DTO却不是这种情况-它们是简单的对象,只不过是属性,设置器和获取器。
任何帮助将不胜感激!
最佳答案
问题在于XMLGregorianCalendar
有两种setYear
方法:setYear(int year)
和setYear(BigDecimal year)
。您需要告诉swagger忽略其中之一,您可以为XMLGregorianCalendar
配置mixin以仅使用吸气剂(类似于this)。如果仅在返回值的上下文中使用XMLGregorianCalendar,这将起作用。
如果不是这种情况,则可以使用directModelSubstitute
option设置替换类型。配置为SwaggerSpringMvcPlugin
时,您可以尝试以下选项之一
@Bean
public SwaggerSpringMvcPlugin yourPlugin() {
...
plugin.directModelSubstitute(XMLGregorianCalendar.class, String.class)
//OR this, depending on how you intend to use it and how you want
// the serialized/deserialized types to appear on the swagger UI
plugin.directModelSubstitute(XMLGregorianCalendar.class, Date.class)
...
return plugin
}
或者,如果您不关心API文档中表示的类型,则可以ignore the type as well。