如何在多個 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上可用