From fdbb513cb27348fca77665ed97b6a5911efb352d Mon Sep 17 00:00:00 2001 From: John Niang Date: Wed, 27 Jul 2022 18:46:13 +0800 Subject: [PATCH] Add all-api group for swagger (#2278) #### What type of PR is this? /kind improvement /area core /milestone 2.0 #### What this PR does / why we need it: Add all-api group for swagger. Related to https://github.com/halo-dev/halo/pull/2273. #### Does this PR introduce a user-facing change? ```release-note None ``` --- .../run/halo/app/config/SwaggerConfig.java | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/src/main/java/run/halo/app/config/SwaggerConfig.java b/src/main/java/run/halo/app/config/SwaggerConfig.java index 633cc44f8..247018807 100644 --- a/src/main/java/run/halo/app/config/SwaggerConfig.java +++ b/src/main/java/run/halo/app/config/SwaggerConfig.java @@ -30,8 +30,8 @@ public class SwaggerConfig { @Bean GroupedOpenApi extensionCoreApi() { return GroupedOpenApi.builder() - .group("CoreAPI") - .displayName("Core API") + .group("core-api") + .displayName("Core APIs") .pathsToMatch("/api/**") .build(); } @@ -39,8 +39,8 @@ public class SwaggerConfig { @Bean GroupedOpenApi extensionApi() { return GroupedOpenApi.builder() - .group("ExtensionAPI") - .displayName("Extension API") + .group("extension-api") + .displayName("Extension APIs") .pathsToMatch("/apis/**") .pathsToExclude("/apis/api.halo.run/**", "/apis/plugin.api.halo.run/**") .build(); @@ -49,8 +49,8 @@ public class SwaggerConfig { @Bean GroupedOpenApi systemCustomApi() { return GroupedOpenApi.builder() - .group("SystemCustomAPI") - .displayName("System Custom API") + .group("core-custom-api") + .displayName("Custom APIs in Core") .pathsToMatch("/apis/api.halo.run/**") .build(); } @@ -58,10 +58,19 @@ public class SwaggerConfig { @Bean GroupedOpenApi pluginCustomApi() { return GroupedOpenApi.builder() - .group("PluginCustomAPI") - .displayName("Plugin Custom API") + .group("plugin-custom-api") + .displayName("Custom APIs in Plugin") .pathsToMatch("/apis/plugin.api.halo.run/**") .build(); } + @Bean + GroupedOpenApi allApi() { + return GroupedOpenApi.builder() + .group("all-api") + .displayName("All APIs") + .pathsToMatch("/api/**", "/apis/**") + .build(); + } + }