springdoc-openapi-ui swagger不理解@ path variable required = false flag

Question

我使用此库生成文档：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.0</version>
</dependency>

我有这个控制器：

@RestController
public class TestController {

    @GetMapping("/test{hz}")
    public String test(@PathVariable(value = "hz", required = false) String hz) {
        return "test";
    }
}

但是我留档：

为什么< code>required = false不起作用？

我试过这个:

@RestController
public class TestController {

    @GetMapping("/test{hz}")
    public String test(
            @Parameter(description = "foo", required = false)
            @PathVariable(value = "hz", required = false) String hz) {
        return "test";
    }
}

这也不管用

编辑：（回答@Helen comment）-我当然知道这一点：

@RestController
public class TestController {

    @GetMapping(value = {"/test", "/test{hz}"})
    public String test(
            @Parameter(description = "foo", required = false)
            @PathVariable(value = "hz", required = false) String hz) {
        return "test";
    }
}

我试过了这个：

@PathVariable(value = "hz", required = false) Optional<String> hz

它使文档变得更糟。所以我没有加这个代码。对于< code>{"/test "，"/test{hz}"}，它看起来像这样:

Answer 1

这符合 OpenAPI 规范。

当客户端进行API调用时，每个路径参数都必须替换为实际值。在OpenAPI中，路径参数是使用in: path定义的。参数名称必须与路径中指定的名称相同。还要记住添加required: true，因为路径参数总是必需的。

您可以查看以下文档：

< Li > https://swagger . io/docs/specification/descripting-parameters/# path-parameters