如何将Swagger UI的参数设置为下拉菜单而不是文本输入

Question

我使用swagger来显示我的RESTApi,API的一个参数将字符串作为输入并将其转换为枚举值.有没有办法在Swagger UI上显示下拉菜单而不是文本输入字段,以便用户只能在枚举值中选择字符串值.

Answer 1

关键是allowableValues在@ApiParam注解中使用。

显示结果的演示：

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

查看pet/findByStatus，它不是下拉列表，但多选框中的输入受到限制。

Answer 2

您可以使用以下swagger代码显示下拉列表.你必须使用枚举.例如,如果你想把性别作为输入,那么可以有三个可能的值

• 男性,女性,其他

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

Answer 3

您可以直接使用enum而不是String参数作为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;
    }

}