Come ottenere il parametro UI di Swagger da menu a discesa invece di immissione testo

Question

Sto usando lo swagger per visualizzare RESTApi, un parametro di un'API accetta la stringa come input e la converte in valore enum. Esiste un modo per visualizzare un menu a discesa sull'interfaccia utente di Swagger invece di avere un campo di immissione testo in modo che gli utenti possano selezionare solo i valori stringa all'interno del valore enum.

Answer 1

Il codice utilizza allowableValues nell'annotazione @ApiParam.

La demo che mostra il risultato:

http://petstore.swagger.io/#!/pet/findPetsByStatus

Partenza pet/findByStatus, non è un menu a discesa, ma in ingresso è limitata nella casella di selezione multipla.

Answer 2

è possibile visualizzare il menu a discesa utilizzando il seguente codice di swagger. Devi usare enum. ad es. se si vuole prendere genere come input allora non ci può essere di tre possibili valori

• maschio, femmina, altri

-name: "gender" 
      in: "query" 
      type: "string" 
      enum: [ "male", "female", "other"] 
      description: "Enter user gender here." 
      required: true 

Answer 3

È possibile utilizzare direttamente enum invece di parametro String come Parametro API

@RequestMapping(value = "/test", method = RequestMethod.POST) 
public void test(EnumTest enum) { 
    // body 
} 

EnumTest.java

public enum EnumTest { 

    One("One"), 
    Two("Two"); 

    private String str; 

    EnumTest(String str){ 
     this.str = str; 
    } 

    public String getStr() { 
     return str; 
    } 

}