Spring boot Springfox/Swagger忽略嵌套对象的@XmlElement注释
我有下面的模式Spring boot Springfox/Swagger忽略嵌套对象的@XmlElement注释,spring-boot,swagger,springfox,restapi,Spring Boot,Swagger,Springfox,Restapi,我有下面的模式 <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="sampleRequest"> <xs:complexType> <xs:s
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="sampleRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="Lookup" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="accountidtgroup">
<xs:complexType>
<xs:sequence>
<xs:element name="accountIDType" type="xs:string" />
<xs:element name="accountIDValue" type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="sysPlanID" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="sampleResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="Dummy" type="xs:string"/>
<xs:element name="OriginalReq">
<xs:complexType>
<xs:sequence>
<xs:element ref="sampleRequest"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
我用它生成类,除了在Swagger UI中将“Lookup”元素转换为小写(从技术上讲,它是对象名),而实际上它应该是“Lookup”之外,一切都正常。如果我只是删除/注释掉sampleRequest中的“OriginalReq”元素,重新构建并重新启动我的应用程序,“Lookup”元素的情况在请求中看起来很好。这里需要注意的重要一点是,“OriginalReq”元素实际上是对“sampleRequest”元素本身的引用,这是问题的根本原因
以下是我的pom依赖项
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
伊奥·斯普林福克斯
springfox-Swagger 2
2.9.2
伊奥·斯普林福克斯
springfox招摇过市用户界面
2.9.2
我做了一些调查,springfox的早期版本存在Jaxb注释的问题,但在以后的版本中得到了修复。证明是响应中的“Dummy”元素大小写正确,如果我在@XmlElement annotation中手动将其更改为其他内容,我可以看到更新的值,这意味着该注释被接受,但对于Lookup元素,它不起作用。因此,问题只存在于嵌套元素具有公共元素的情况下
以前是否有人遇到过类似的问题,或者是否有解决办法?为处于类似情况的人找到了解决办法 解决方法是向有问题的元素添加@JsonProperty注释。就这样。Swagger将识别注释并显示正确的元素大小写/名称 对于那些从xsd模式生成类的人来说,还有几个步骤
com.fasterxml.jackson.core
. 这是一个应用非常广泛的开源软件。
对于Springfox,我尝试了使用版本2.9.0和3.0.0进行测试,但仍然存在相同的问题。在我写这篇文章的时候,我认为这是springfox库中的一个bug,我在Github上提出了这个问题,但还没有得到回复。这里有一个链接为处于类似情况的任何人找到了解决办法
解决方法是向有问题的元素添加@JsonProperty注释。就这样。Swagger将识别注释并显示正确的元素大小写/名称
对于那些从xsd模式生成类的人来说,还有几个步骤
将以下依赖项添加到pom.xml依赖项部分
com.fasterxml.jackson.core
. 这是一个应用非常广泛的开源软件。
对于Springfox,我尝试了使用版本2.9.0和3.0.0进行测试,但仍然存在相同的问题。在我写这篇文章的时候,我认为这是springfox库中的一个bug,我在Github上提出了这个问题,但还没有得到回复。这是链接
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.8.6</version>
</dependency>
<dependency>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics-annotate</artifactId>
<version>1.1.0</version>
</dependency>
<build>
<plugins>
<plugin>
<groupId>org.jvnet.jaxb2.maven2</groupId>
<artifactId>maven-jaxb2-plugin</artifactId>
<version>0.14.0</version>
<executions>
<execution>
<id>xjc</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<schemaDirectory>${schema.src.dir}/abc</schemaDirectory>
<schemaIncludes>
<include>*.xsd</include>
</schemaIncludes>
<generatePackage>${generated.package.abc}</generatePackage>
<generateDirectory>${generated.dir}/abc</generateDirectory>
<cleanPackageDirectories>true</cleanPackageDirectories>
<bindings>
<binding>
<fileset>
<directory>${schema.binding.dir}/abc</directory>
<includes>
<include>bindings.xjb</include>
</includes>
</fileset>
</binding>
</bindings>
<extension>true</extension>
<args>
<arg>-Xannotate</arg>
</args>
<plugins>
<plugin>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics</artifactId>
<version>1.11.1</version>
</plugin>
<plugin>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics-annotate</artifactId>
<version>1.1.0</version>
</plugin>
<plugin>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.8.6</version>
</plugin>
</plugins>
</configuration>
</execution>
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE jaxb:bindings SYSTEM "../common/resources.dtd">
<jaxb:bindings version="2.0" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:annox="http://annox.dev.java.net"
jaxb:extensionBindingPrefixes="annox">
<jaxb:bindings schemaLocation="&ApiPath;/schema.xsd">
<jaxb:bindings node="//xs:element[@name='Lookup']">
<annox:annotate target="field">@com.fasterxml.jackson.annotation.JsonProperty("Lookup")</annox:annotate>
</jaxb:bindings>