Spring Boot + Swagger - XML Example Values fehlerhaft

[Jockelmei]

Hallo,
ich habe momentan folgendes Problem:

Angenommen ich habe folge Klasse:

public class bar{
   
    protected List<TestDTO> foos = new ArrayList<>();

    public bar() {
        super();
    }

    public bar(List<TestDTO> foos) {
        super();
        this.foos = foos;
    }

    @XmlElementWrapper
    @XmlElement(name="foo")
    public List<TestDTO> getFoos() {
        return foos;
    }

    public void setFoos(List<TestDTO> foos) {
        this.foos = foos;
    }
}

Im Swagger (springfox-swagger2, springfox-swagger-ui beide in der Version 2.8.0) erhalte ich bei meinen Schnittstellen folgende XMLExample Values:

<bar>
    <foo>
        <foo>
            <password>string</password>
            <user>string</user>
        </foo>
    </foo>
</bar>

Ich brauche jedoch das XML wie folgt:

<bar>
    <foos>
        <foo>
            <password>string</password>
            <user>string</user>
        </foo>
    </foos>
</bar>

Kann mir dabei jemand weiterhelfen?

Danke und VG

 

[Flown]

@XmlElementWrapper(name="foos") hilft nicht?

 

[Jockelmei]

@XmlElementWrapper(name="foos") hilft nicht?

leider auch nicht. Mit @XmlElementWrapper(name ="foos") spucht Swagger-UI folgendes XML aus :

<bar>
    <foos>
        <foos>
            <password>string</password>
            <user>string</user>
        </foos>
    </foos>
</bar>

Es scheint als ob dadurch die

@XmlElement(name="foo")

Annotation überschrieben wird.

Ich habe mal ein Test geschrieben, bei dem ich via XMLMapper mir das Object ausgeben lasse. Ergebnis:

<bar><foos><foo><user>user</user><password>test</password></foo></foos></bar>

Da scheint also alles in Ordnung zu sein. Scheint wohl ein Swagger/Swagger-UI Problem zu sein. Leider ist es recht wichtig das die Dokumentation (und somit auch das Example) im Swagger korrekt ist.

Weiß noch jemand Rat?

Danke und viele Grüße!

 

[mrBrown]

Sieht nach diesem Fehler aus: https://github.com/swagger-api/swagger-ui/issues/2907

Wie sieht denn das generierte Model aus?

 

[Jockelmei]

Das von Swagger generierte Model sieht wie folgt aus:

 bar {
foos (Array[foo], optional):

foos
}
foo {
password (string, optional),
user (string, optional)
}

Das sieht zumindest gut aus soweit ich es sehe. Allerdings brauche ich die korrekte Struktur in den Example Values.

Jap das sieht genau nach dem Fehler aus.. die Tatsache das dies ein open issue von 2017 ist spricht wohl dafür das es dafür noch keine Lösung gibt 🙁

VG