From 0322c3ecf2215a83f7a7c1a3aaac21ce7043486a Mon Sep 17 00:00:00 2001 From: Charles7c Date: Sun, 15 Jun 2025 17:58:42 +0800 Subject: [PATCH] =?UTF-8?q?chore:=20=E6=A0=BC=E5=BC=8F=E5=8C=96=E9=83=A8?= =?UTF-8?q?=E5=88=86=E4=BB=A3=E7=A0=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 +-- .../doc/GlobalSpringDocConfiguration.java | 38 +++++++++++-------- .../generator/config/CodeConfiguration.java | 22 ++++++++--- .../admin/open/config/OpenConfiguration.java | 22 ++++++++--- .../config/ScheduleConfiguration.java | 22 ++++++++--- .../admin/auth/config/AuthConfiguration.java | 22 ++++++++--- .../system/config/SystemConfiguration.java | 22 ++++++++--- 7 files changed, 111 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 72104a83..84340803 100644 --- a/README.md +++ b/README.md @@ -263,8 +263,8 @@ git clone https://github.com/continew-org/continew-admin.git # [3.也可以在 IntelliJ IDEA 中直接配置程序启动环境变量（DB_HOST、DB_PORT、DB_USER、DB_PWD、DB_NAME；REDIS_HOST、REDIS_PORT、REDIS_PWD、REDIS_DB）] # 4.启动程序 -# 4.1 启动成功：访问 http://localhost:8000/，页面输出：Xxx started successfully. -# 4.2 接口文档：http://localhost:8000/doc.html +# 启动成功，在控制台末尾会输出 ContiNew Admin service started successfully. +# 并输出 API 地址及 API 接口文档地址 ``` ## 项目结构 @@ -274,7 +274,7 @@ git clone https://github.com/continew-org/continew-admin.git ``` continew-admin -├─ continew-server（API 及打包部署模块） +├─ continew-server（打包部署模块） │ ├─ src │ │ ├─ main │ │ │ ├─ java/top/continew/admin diff --git a/continew-common/src/main/java/top/continew/admin/common/config/doc/GlobalSpringDocConfiguration.java b/continew-common/src/main/java/top/continew/admin/common/config/doc/GlobalSpringDocConfiguration.java index 36a1b8b8..fbf893c5 100644 --- a/continew-common/src/main/java/top/continew/admin/common/config/doc/GlobalSpringDocConfiguration.java +++ b/continew-common/src/main/java/top/continew/admin/common/config/doc/GlobalSpringDocConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.common.config.doc; import org.springdoc.core.models.GroupedOpenApi; @@ -16,28 +32,20 @@ public class GlobalSpringDocConfiguration { @Bean public GroupedOpenApi allApi() { return GroupedOpenApi.builder() - .group("all") - .displayName("全部接口") - .pathsToMatch("/**") - .packagesToExclude("/error") - .build(); + .group("all") + .displayName("全部接口") + .pathsToMatch("/**") + .packagesToExclude("/error") + .build(); } @Bean public GroupedOpenApi commonApi() { - return GroupedOpenApi.builder() - .group("common") - .displayName("通用接口") - .pathsToMatch("/common/**") - .build(); + return GroupedOpenApi.builder().group("common").displayName("通用接口").pathsToMatch("/common/**").build(); } @Bean public GroupedOpenApi monitorApi() { - return GroupedOpenApi.builder() - .group("monitor") - .displayName("系统监控") - .pathsToMatch("/monitor/**") - .build(); + return GroupedOpenApi.builder().group("monitor").displayName("系统监控").pathsToMatch("/monitor/**").build(); } } diff --git a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java index e74ce965..38dd2f1e 100644 --- a/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java +++ b/continew-plugin/continew-plugin-generator/src/main/java/top/continew/admin/generator/config/CodeConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.generator.config; import org.springdoc.core.models.GroupedOpenApi; @@ -18,10 +34,6 @@ public class CodeConfiguration { */ @Bean public GroupedOpenApi codeApi() { - return GroupedOpenApi.builder() - .group("code") - .displayName("代码生成") - .pathsToMatch("/code/**") - .build(); + return GroupedOpenApi.builder().group("code").displayName("代码生成").pathsToMatch("/code/**").build(); } } diff --git a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java index d4982145..6f3f42e4 100644 --- a/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java +++ b/continew-plugin/continew-plugin-open/src/main/java/top/continew/admin/open/config/OpenConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.open.config; import org.springdoc.core.models.GroupedOpenApi; @@ -18,10 +34,6 @@ public class OpenConfiguration { */ @Bean public GroupedOpenApi openApi() { - return GroupedOpenApi.builder() - .group("open") - .displayName("能力开放") - .pathsToMatch("/open/**") - .build(); + return GroupedOpenApi.builder().group("open").displayName("能力开放").pathsToMatch("/open/**").build(); } } diff --git a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java index 238bc0a0..d111edc6 100644 --- a/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java +++ b/continew-plugin/continew-plugin-schedule/src/main/java/top/continew/admin/schedule/config/ScheduleConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.schedule.config; import org.springdoc.core.models.GroupedOpenApi; @@ -18,10 +34,6 @@ public class ScheduleConfiguration { */ @Bean public GroupedOpenApi scheduleApi() { - return GroupedOpenApi.builder() - .group("schedule") - .displayName("任务调度") - .pathsToMatch("/schedule/**") - .build(); + return GroupedOpenApi.builder().group("schedule").displayName("任务调度").pathsToMatch("/schedule/**").build(); } } diff --git a/continew-system/src/main/java/top/continew/admin/auth/config/AuthConfiguration.java b/continew-system/src/main/java/top/continew/admin/auth/config/AuthConfiguration.java index 069a359e..70c1ac8c 100644 --- a/continew-system/src/main/java/top/continew/admin/auth/config/AuthConfiguration.java +++ b/continew-system/src/main/java/top/continew/admin/auth/config/AuthConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.auth.config; import org.springdoc.core.models.GroupedOpenApi; @@ -18,10 +34,6 @@ public class AuthConfiguration { */ @Bean public GroupedOpenApi authApi() { - return GroupedOpenApi.builder() - .group("auth") - .displayName("系统认证") - .pathsToMatch("/auth/**") - .build(); + return GroupedOpenApi.builder().group("auth").displayName("系统认证").pathsToMatch("/auth/**").build(); } } diff --git a/continew-system/src/main/java/top/continew/admin/system/config/SystemConfiguration.java b/continew-system/src/main/java/top/continew/admin/system/config/SystemConfiguration.java index d7b584cd..e99deed7 100644 --- a/continew-system/src/main/java/top/continew/admin/system/config/SystemConfiguration.java +++ b/continew-system/src/main/java/top/continew/admin/system/config/SystemConfiguration.java @@ -1,3 +1,19 @@ +/* + * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package top.continew.admin.system.config; import org.springdoc.core.models.GroupedOpenApi; @@ -18,10 +34,6 @@ public class SystemConfiguration { */ @Bean public GroupedOpenApi systemApi() { - return GroupedOpenApi.builder() - .group("system") - .displayName("系统管理") - .pathsToMatch("/system/**") - .build(); + return GroupedOpenApi.builder().group("system").displayName("系统管理").pathsToMatch("/system/**").build(); } }