0

这有点奇怪。springdoc-openapi-ui v1.2.32，生成的文档仅包含控制器内的少数映射。

例子：

    @Operation(
            summary = "Foo",
            description = "Foo"
    )
    @PostMapping(path="/v1/foo")
    public ResponseEntity<ResponseObject> postFoo(@RequestBody FooRequestObject searchRequest, HttpServletRequest request){ ... }


    @Operation(
            summary = "Bar",
            description = "Bar"
    )
    @GetMapping(path="/v1")
    public ResponseEntity<ResponseObject> getBar(@RequestBody BarRequestObject request, HttpServletRequest request){ ... }


    @Operation(
            summary = "Bar",
            description = "Bar"
    )
    @PostMapping(path="/v1")
    public ResponseEntity<ResponseObject> postBar(@RequestBody BarRequestObject request, HttpServletRequest request){ ... }

文档只为postBar和getBar服务生成，其他路径被忽略。

我试过的：

  1. 最初这两种 POST 方法都被命名为post. 我重命名以避免冲突。
  2. 我没有设置控制器级别的路径。
  3. 检查注释导入
  4. 未命中文档的缓存版本

如果我向控制器添加另一个服务（带有或不带有注释标记），它也不会显示在生成的 Swagger 中。例如：

@GetMapping(path="/test")
public String getTest(){
    return "test";
}

如果我将此方法添加到全新的控制器，则会生成 doc。

谢谢

编辑 配置类

@Configuration
public class SwaggerConfig {                                    

    @Bean
    public OpenAPI springOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("My API")
                .description("My API service documentation. ")
                .version("v1.0")
                .license(new License().name("Terms of Use").url("https://myapi.com/terms.html")));
    }
    
}
4

1 回答 1

3

您面临的问题是由于您使用了 1 级引用，这导致 Springdoc 过滤仅在指定路径上paths-to-match可用的端点。

springdoc.paths-to-match=/api/v1,/v2,/v3,/status

上述属性匹配以 , , ,开头和结尾的端点。这无法匹配可能具有类似或什至等形式的端点。/v2/v3/status/api/v1/users/v2//v2/users

虽然不支持完整的正则表达式来指定您想要包含的端点，但是对此的基本支持**可以帮助您指定您想要包含/排除的级别。

考虑以下示例

springdoc.paths-to-match=/**/v1/**/

它将包括其中包含的任何端点/v1/。/users/v1/像和/v1/dasboard的例子/user/v1/dashboard。

springdoc.paths-to-match=/v2/**

它只会匹配以 n 级深度开始/v2并进入 n 级深度的端点。诸如此类的示例/v2/dashboard将被包括在内，但/users/v2/something将被排除在外。

springdoc.paths-to-match=/**/v1

它只会匹配以 结尾的路径/v1。像这样的例子/users/v1会被匹配，而那些像/v1/user不会被匹配。

或者，你也可以更新你Bean的做同样的事情。但请注意，属性文件优先于 bean 配置。

// you existing bean here

// Define an API group that'll include specific version. Can be helpful in versioning the APIs.
@Bean
public GroupedOpenApi hideApis() {
    return GroupedOpenApi.builder().group("default")
            .pathsToExclude("/api/v2/**", "/v2/**", "/**/v3/**")
            .pathsToMatch("/v1/**", "/api/v1/**")
            .build();
}
于 2021-03-15T11:01:29.743 回答