在 Spring Boot 中使用 Swagger 为路径变量指定 API 端点上可用的选项

Question

我有以下控制器方法

@ApiOperation(value = "Send a signin request with a provider")
@GetMapping("/{provider}/signin")
public void signIn(@PathVariable String provider, HttpServletResponse response) {
    service.signIn(provider, response);
}

我想知道的是，是否有指定可能值的方法，可以在提供程序路径变量中传递]. 在 Swagger 文档上，我看到了一些关于枚举的内容，但我不知道如何在我的 Spring 启动应用程序上使用它。在 SpringFox 文档中我找不到枚举这个词。提前致谢

Answer 1

这里是生成可用选项的示例代码。这个例子展示了如何 multi-select 可用选项。只需对单个 select

使用 String 而不是 List

@GetMapping(value = "/request/......", produces = {"application/xml"})
public ResponseEntity<?> createMandate(@NotNull @ApiParam(value = "Test 
Case", required = true, allowableValues = "happy-path, dirty-path, wrong-
path") @RequestParam(value = "TestCase", required = true) List<String> 
testCases,
                                                           @NotNull 
@ApiParam(value = "Another Text Field input") @RequestParam(value = 
"CustomerMSISDN", required = true) String customerMsisdn) {
    return ??
}

在 Spring Boot 中使用 Swagger 为路径变量指定 API 端点上可用的选项

Specify options available on API endpoint for a path variable with Swagger in Spring Boot

path-variables

spring-boot

swagger-2.0