Swagger-ui - Abfrage param

Ich bin mit Swagger-ui-und Fors core (1.3) für eine jersey-Applikation. Ich habe bestimmte query-Parameter, die ich senden muss mit jeder Anfrage wie post, get, delete...

Wie kann ich Standard ?

  • Könnten Sie wählen Sie eine richtige Antwort ?
InformationsquelleAutor Jacaro | 2015-07-01
  1. 8

    Können Sie die annotation @ApiParam von Fors Anmerkungen um zu konfigurieren Sie die Abfrage param verwendet werden, aus dem Swagger-UI.

    Beispielsweise

    @Path("/{username}")
@ApiOperation(value = "Updated user")
public Response updateUser(
  @ApiParam(value = "description for query-parameter") @QueryParam("username") String username
) {
...
}

    Bitte, Lesen Sie mehr über diese Anmerkung in den folgenden amtlichen Unterlagen:
    https://github.com/swagger-api/swagger-core/wiki/Annotations#apiparam

    • ApiParam für queryparam kann nur verwendet werden, wenn der Betrieb über solche parameter in der definition. Aber, ich will hier senden Sie eine Abfrage-parameter mit der url an, die aufgerufen werden, wenn eine post oder get-oder delete-operation ausprobiert. Hoffe, du verstehst, was ich Suche
    InformationsquelleAutor ipeluffo
  2. 0

    Können Sie nicht, aber da swagger 2.0 (ich weiß nicht, ob das unterstützt wird von swagger-code/swagger-ui), Sie kann definiert Parameter Wiederverwendung über Operationen.

    Beispiel :

    {
  "parameters": {
    "pageParam": {
      "name": "page",
      "in": "query",
      "description": "page number to get",
      "required": false,
      "type": "integer",
      "format": "int32"
    }
  },
  "paths": {
    "/customers": {
      "get":  {
        "description": "Retrive list of customers",
        "parameters": {
          "$ref": "#/parameters/pageParam"
        },
        ...
      }
    }
  },
  ...
}
    InformationsquelleAutor Nelson G.
Schreibe einen Kommentar