Swagger-Dokumentation für Spring Pageable-Schnittstelle
Ich habe einen Microservice mit Spring Boot entwickelt. Die Dokumentation für die REST API wird mit Swagger erstellt. Einige REST-Ressourcen verwenden Spring-Konzepte, um die Paginierung kostenlos bereitzustellen. Unten ist ein Beispiel:
%Vor%Wenn ich die Swagger-Seite öffne, ist das folgende Formular für die Ressource verfügbar:
Das Problem, das ich habe, ist, dass der auslagerbare Parameter mit content-type application / json erkannt wird und ich nicht weiß, wie man einen Wert übergibt, um beispielsweise die Seitengröße zu ändern. Alle Werte scheinen ignoriert zu werden.
Ist es möglich, die Abfrageparameter als JSON-Objekt zu übergeben? Oder ist es möglich, Swagger zu konfigurieren, um unabhängige Abfrageparameterfelder für Getter zu erzeugen, die in der anordnungsfähigen Schnittstelle enthalten sind?
Bitte beachten Sie, dass ich Springfox mit Gradle verwende:
%Vor%3 Antworten
Vineet Bhatias Antwort mit @ApiImplicitParams sieht gut aus. Aber ich habe mich mit der Situation konfrontiert, wenn @ApiIgnor und @ApiParam(hidden = true) nicht funktioniert und Sie immer noch den aSembler und die auslagerbaren Params beobachten können. Ich habe dieses Problem behoben, indem ich die nächste Zeile hinzugefügt habe
zu der Docky-Bean in meinem SwaggerConfig .
Antwort von Vineet Bhatia wird ein Validierungsproblem haben, wenn Sie nicht auf localhost laufen. Es wird für Integer-Parameter argumentieren, dass sie nicht dem JSON-Schema entsprechen.
Also habe ich Integer in String geändert:
%Vor%