SpringFox Swagger创建XSD模型所需的定义属性

Question

我有一个REST webapp，它使用Swagger来编写文档，除了body参数外，它的工作效果很好。主体的所有属性都是可选的

我的Project对象是用一个XSD文件生成的，我确保所有元素中的minOccurs=1，maxOccurs=1或unbounded以及我的所有属性都设置为use=required。这似乎对它没有任何影响。接下来我试着添加了

@apiparam（value=“项目主体”,required=true）@requestbody ProjectInfo项目

//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.11 
// See <a href="http://java.sun.com/xml/jaxb">http://java.sun.com/xml/jaxb</a> 
// Any modifications to this file will be lost upon recompilation of the source schema. 
// Generated on: 2016.02.12 at 09:33:59 AM CET 
//


package be.smartask.api.model.post;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import javax.xml.bind.annotation.*;


/**
 * <p>Java class for anonymous complex type.
 * <p>
 * <p>The following schema fragment specifies the expected content contained within this class.
 * <p>
 * <pre>
 * &lt;complexType&gt;
 *   &lt;complexContent&gt;
 *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt;
 *       &lt;attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /&gt;
 *     &lt;/restriction&gt;
 *   &lt;/complexContent&gt;
 * &lt;/complexType&gt;
 * </pre>
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
@XmlRootElement(name = "projectInfo")
@ApiModel
public class ProjectInfo {

    @XmlAttribute(name = "name", required = true)
    protected String name;

    /**
     * Gets the value of the name property.
     *
     * @return possible object is
     * {@link String }
     */
    @ApiModelProperty(value = "The unique name of the project", required = true)
    public String getName() {
        return name;
    }

    /**
     * Sets the value of the name property.
     *
     * @param value allowed object is
     *              {@link String }
     */
    public void setName(String value) {
        this.name = value;
    }

}

但是现在我的问题变成了我可以在XSD文件中添加Swagger注释，这样它就可以自己生成了吗？

Answer 1

我需要的注释是@APIModelProperty(value=“”,required=true）

要想从我的退出中得到这个结果是一个挑战，但我通过接下来的步骤设法做到了这一点。

将此添加到pom.xml中

<plugin>
    <groupId>org.jvnet.jaxb2.maven2</groupId>
    <artifactId>maven-jaxb2-plugin</artifactId>
    <version>0.13.1</version>
    <configuration>
        <forceRegenerate>true</forceRegenerate>
        <extension>true</extension>
        <args>
            <arg>-Xannotate</arg>
        </args>
        <plugins>
            <plugin>
                <groupId>org.jvnet.jaxb2_commons</groupId>
                <artifactId>jaxb2-basics-annotate</artifactId>
                <version>1.0.2</version>
            </plugin>
            <plugin>
                <groupId>org.jvnet.jaxb2_commons</groupId>
                <artifactId>jaxb2-annotate-plugin-test-annox-annotations</artifactId>
                <version>1.0.0</version>
            </plugin>
        </plugins>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.3.1</version>
        </dependency>
    </dependencies>
</plugin>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns:xsd="http://www.w3.org/2001/XMLSchema"
           xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
           jaxb:version="2.1"
           xmlns:annox="http://annox.dev.java.net"
           jaxb:extensionBindingPrefixes="annox">

<xs:element name="projectInfo">
    <xs:complexType>
        <xsd:annotation>
            <xsd:appinfo>
                <annox:annotate target="getter">@io.swagger.annotations.ApiModel(value = "project")</annox:annotate>
            </xsd:appinfo>
        </xsd:annotation>
    </xs:complexType>
</xs:element>

在方法级别，像这样

<xs:element name="projectInfo">
    <xs:complexType>
        <xsd:annotation>
            <xsd:appinfo>
                <annox:annotate target="getter">@io.swagger.annotations.ApiModel(value = "project")</annox:annotate>
            </xsd:appinfo>
        </xsd:annotation>
        <xs:attribute type="xs:string" name="name" use="required">
            <xsd:annotation>
                <xsd:appinfo>
                    <annox:annotate target="getter">@io.swagger.annotations.ApiModelProperty(value="Must be unique", required = true)</annox:annotate>
                </xsd:appinfo>
            </xsd:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>

更多信息可以在这里找到

• https://github.com/highsource/jaxb2-annotate-plugin
• https://java.net/jira/browse/jaxb2_commons-32