Преглед изворни кода

docs(api): 更新接口文档配置信息

- 修改API标题为ChronicDiseaseApp API
- 更新API描述为慢病APP后端接口文档
- 将版本号从v0更新为v1
- 修改分组名称为chronicdiseaseapp-api
- 更新包扫描路径为work.baiyun.chronicdiseaseapp
mcbaiyun пре 2 месеци
родитељ
комит
67493a8ed8
1 измењених фајлова са 6 додато и 7 уклоњено
  1. 6 7
      src/main/java/work/baiyun/chronicdiseaseapp/config/Knife4jConfig.java

+ 6 - 7
src/main/java/work/baiyun/chronicdiseaseapp/config/Knife4jConfig.java

@@ -14,10 +14,9 @@ public class Knife4jConfig {
     public OpenAPI customOpenAPI() {
     public OpenAPI customOpenAPI() {
         return new OpenAPI()
         return new OpenAPI()
                 .info(new Info()
                 .info(new Info()
-                        .title("Verification API")
-                        .description("提供Verification服务的接口文档")
-                        .version("v0")
-//                        .termsOfService("None")
+                        .title("ChronicDiseaseApp API")
+                        .description("慢病APP 后端接口文档")
+                        .version("v1")
                         .contact(new Contact()
                         .contact(new Contact()
                                 .name("baiyun")
                                 .name("baiyun")
                                 .url("https://baiyun.work/")
                                 .url("https://baiyun.work/")
@@ -30,9 +29,9 @@ public class Knife4jConfig {
     @Bean
     @Bean
     public GroupedOpenApi publicApi() {
     public GroupedOpenApi publicApi() {
         return GroupedOpenApi.builder()
         return GroupedOpenApi.builder()
-                .group("verification-api")
-                // Updated: 修改为当前项目的基础包路径
-                .packagesToScan("work.baiyun.verification")
+                .group("chronicdiseaseapp-api")
+                // 修改为当前项目的基础包路径以便扫描控制器
+                .packagesToScan("work.baiyun.chronicdiseaseapp")
                 .build();
                 .build();
     }
     }
 }
 }