如何在swagger中获取可能的值

时间:2017-08-04 10:13:21

标签: java rest web-services swagger swagger-ui

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

下面的

是我的API之一。

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

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

所以我想放下招摇的视线。

我已经通过谷歌搜索,我找不到如何用java实现。

2 个答案:

答案 0 :(得分:3)

您必须使用枚举作为方法参数,而不是字符串。见以下参考:

@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;
    }
}

答案 1 :(得分:0)

您可以使用可能的值

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