如何在多个 swagger 页面中公开我的 Rest 服务。

Question

我正在使用 Spring 启动来创建一些 Rest 服务。 如何在多个 swagger 页面中公开我的 Rest 服务。 例如所有删除方法都在一个单独的页面中！

Answer 1

您可以使用标签来更改分组，如此处所述：使用标签对操作进行分组 。

这是您可以在控制器方法上使用的示例注释：

@ApiOperation(tags = { "delete" }, value = "this API operation will be grouped under the delete section", nickname = "myMethod")

Answer 2

如果您使用的是springdoc-openapi ，则可以创建多个@RestController类并将它们分成组，如此处所述。

如上面链接中所述，您必须启用条目springdoc.api-docs.groups.enabled=true

并在您的配置中创建一个组

@Bean
public GroupedOpenApi storeOpenApi() {
    String paths[] = {"/store/**"};
    return GroupedOpenApi.builder().setGroup("stores").pathsToMatch(paths)
            .build();
}

商店 open-api json 将在http://host:port/v3/api-docs/store上可用