Customizing-Request-Header Beschreibung in Swagger-UI mit Springfox-Swagger2

Ich bin mit Springfox Swagger2 version 2.4.0, Springfox Swagger-UI-version 2.4.0 und Swagger Anmerkungen version 1.5.0 in meinem Spring-Boot-Anwendung.

Die Frage hier ist, ich bin in der Lage zu generieren swagger-UI für meine controller-API-und ich bin in der Lage zu testen. Aber ich bin nicht in der Lage, um anzugeben, request-header Beschreibung für meine Anfrage-header. Ich m mit @RequestHeader-Anmerkung für die gleichen.

Den code-Schnipsel in meinem controller-API folgt:

@RequestHeader(name = "Api-Key") String apiKey

Fors UI für den request-header ist wie folgt:

Customizing-Request-Header Beschreibung in Swagger-UI mit Springfox-Swagger2

Den markierten rechteckigen Bereich in der Abbildung stellt die Beschreibung der request-header.

Derzeit nur nimmt die genannten Daten im name-Attribut, und zeigt es. Aber ich will eine andere Beschreibung für den gleichen. D. H. "Wert" license key"

Wie kann ich erreichen, das in Swagger-UI @RequestHeader annotation nur einen Wert haben, defaultValue, Namen und die gewünschten Attribute? Jede Hilfe wäre wirklich zu schätzen.

Update: auf der Suche nach einer Lösung out of the box ohne irgendwelche benutzerdefinierten annotation von meinem eigenen

  • Verstehe nicht, warum diese Frage ist downvoted zweimal?
  • Ich bin verwirrt mit RequestHeader genau wie beschrieben. ApiParam(name, Wert, ..) macht Sinn für mich, und #Wert() ist explizit beschrieben, für die "Beschreibung" (io.stolzieren.Anmerkungen v2.9.2 in meinem Fall). Aber die interface-Deklaration von @RequestHeader in (spring-web.binden.Anmerkungen 5.0.12 in meinem Fall) erklärt #Wert() mit einem AliasFor("name") und #name() mit einem AliasFor("Wert"), wobei die Einstellung sowohl zur gleichen Zeit, die Ergebnisse in ein render-Fehler. Ist das ein bug, oder sollte das Umgekehrt sein RequestHeader::value() sich Verhalten sollte analog ApiParam::value() als Feld "Beschreibung"?
InformationsquelleAutor Gandhi | 2017-02-20
  1. 9

    Vielleicht meine Antwort hilft jemand.

    Wie bereits erwähnt Dilip Krishnan in seine Antwort, die Sie nutzen könnten io.swagger.annotations.ApiParam oder io.swagger.annotations.ApiImplicitParam Swagger Anmerkungen für fein abgestimmte individuelle Dokumentation.

    @ApiParam könnte verwendet werden, für die registrierten Parameter der Methode.

    @ApiImplicitParam könnte verwendet werden, wenn die API-parameter nicht explizit registriert.

    @RestController
@RequestMapping(value = "/v1/test", produces = "application/json")
@Api(value = "/v1/test")
public class TestController {

    @ApiOperation(value = "Do Something method", tags = "Test method")
    @RequestMapping(value = "/doSomeThing", method = RequestMethod.GET)
    public Foo doSomeThing(
            @ApiParam(value = "Param1 Description", required = true)
            @RequestParam String param) {
        throw new UnsupportedOperationException("do Some Things");
    }

    @ApiOperation(value = "Do Something Another method", tags = "Test method")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "anotherParam1", value = "Another Param1 Description", paramType = "header"),
            @ApiImplicitParam(name = "anotherParam1", value = "Another Param1 Description", paramType = "header")
    })
    @RequestMapping(value = "/doSomeThingAnother", method = RequestMethod.GET)
    public Foo doSomeThingAnother(Bar bar) {
        throw new UnsupportedOperationException("do Some Thing Another");
    }


}

    Und am Ende konnte man sehen, Folgendes Bild

    Customizing-Request-Header Beschreibung in Swagger-UI mit Springfox-Swagger2

    • Ich war auf der Suche nach etwas zu tun oben auf Anfrage-header-Parameter. Leider keine api implizite param
    • Beschreibung wurde aktualisiert, um eine reguläre Anfrage-parameter.
    • @ApiParam(value="header description") kann verwendet werden, zusammen mit @RequestHeader zu bieten header-Beschreibung. @DmytroBoichenko aktualisieren Sie die Antwort mit diesem.
    • Ich bin sorry mate, aber derzeit habe ich nicht diesen code und kann nicht überprüfen Sie Ihre Lösung.
    • Ich habe versucht auf diese Weise, aber ich kann nicht sehen, dieser Wert wird gesendet, wie eine Kopfzeile, wenn ich untersuche die Registerkarte Netzwerk-browser-tools.
    InformationsquelleAutor Dmytro Boichenko
  2. 3

    TL;DR ist, dass Sie Ihre eigenen zu bauen-plugin, um es zu tun.

    Im Grunde die einzige out-of-the-box-Anmerkungen zu ergänzen, die der Beschreibung in diesem Fall sind @ApiParam und um genauer zu sein @ApiImplicitParam. Leider keiner von diesen Anmerkungen unterstützen die Beschreibungen.

    Also mein Vorschlag wäre:

    1. Erstellen Sie Ihre eigene Anmerkung, dass würde dann so Aussehen

      @RequestHeader(name = "Api-Key")
      @Description("Value of license key") String apiKey

    HINWEIS: Es ist bereits ein Anmerkung im Frühling, dass dafür geeignet ist.

    1. Erstellen Sie Ihre eigenen ParameterBuilderPlugin
    2. Implementieren Sie das plugin wie unten gezeigt
    public class Test implements ParameterBuilderPlugin {
  @Override
  public void apply(ParameterContext parameterContext) {
    ResolvedMethodParameter methodParameter =parameterContext.resolvedMethodParameter();
    Optional<Description> requestParam = methodParameter.findAnnotation(Description.class);
    if (requestParam.isPresent()) {
      parameterContext.parameterBuilder()
        .description(requestParam.get().value());
    }
  }

  @Override
  public boolean supports(DocumentationType documentationType) {
    return false;
  }
}
    1. Wählen Sie einen Wert von die Reihenfolge, die angewendet wird nachdem swagger Anmerkungen verarbeitet wurden.

    Auch, aktualisieren Sie bitte Ihren springfox Bibliothek der neueste version.

    • Danke für deine schnelle Antwort. Haben nicht viel Aufmerksamkeit auf Dinge, die Sie sagen, so wird versuchen und erhalten Sie zurück zu Ihnen. Nochmals vielen Dank
    • Endlich mal beginnen, auf diese. Aber ich m stecken, am Anfang als ich m ziemlich neu in diesem. Wie Sie bereits erwähnt, ich habe versucht, indem Sie Beschreibung Anmerkung zu meiner Anfrage-header-Parameter und bekam eine Fehlermeldung wie - "annotation-Typ nicht anwendbar auf diese Art der "Erklärung" Kannst du mich führen, in dies? Auch soll ich die test-Klasse in Ihrem Beitrag in meinem spring-Anwendung code? Schließlich, ich m nicht sehr klar darüber, was Sie bedeutete in Schritt 4 Bitte um Rat
    • Wenn u erstellen Sie Ihre Anmerkung stellen Sie sicher, es gilt für Parameter. Verwenden Sie die eine, die kommt mit dem Frühling kann nicht funktionieren. Schritt 4 ist einfach zu sagen, machen Sie sicher, dass das plugin läuft, nachdem swagger plugins. Diese plugins verwenden Federn Bestellen für Bohnen.
    InformationsquelleAutor Dilip Krishnan
  3. 0

    Hatten wir das gleiche Problem, und das problem gelöst in der folgenden Weise:

    .. @RequestHeader(value = "..") @ApiParam(value = "Description") String param ..

    Die Idee ist, fügen Sie "Beschreibung" - Feld in generierte stolzieren. Es könnte Aussehen, hacky, aber es ist eine schnelle einfache Lösung, die nützlich sein können in Ihrem persönlichen Fall.

    • Denke mal das wird fügen Sie eine neue param und nicht update die header Beschreibung
    • Yep, Recht hast du. Wenn das Ziel ist nur, stolzieren, könnte das helfen. Aber im Allgemeinen Fall ist es besser, auf oben genannten Lösungen.
    InformationsquelleAutor Boris
Schreibe einen Kommentar