如何在swagger中获得可能的值的下拉列表

Question

您好我有Rest API，并使用Swagger来测试此API。

下面是我的API之一。

@RequestMapping(value = "/api/test", method = RequestMethod.POST) 
public void test(String string){ 
    // body 
} 

参数的可能值是“数据库”或“缓存”。

所以我想放下在招摇的视野。

我已经通过谷歌搜索，我找不到如何实现与Java。

Answer 1

你必须使用枚举作为方法的参数，而不是字符串的注释你的参数。请参见下面的参考：

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

及以下的TestEnum：

public enum TestEnum { 

    Dropdown1("DropDown1"), 
    DropDown2("DropDown2"); 

    private String str; 

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

    public String getStr() { 
     return str; 
    } 
} 

Answer 2

您可以使用可能值

@RequestMapping(value = "/api/test", method = RequestMethod.POST) 
public void test(@ApiParam(allowableValues = "one, two, three") String string) { 
    // body 
}