feat：接入swagger

application.yaml

@@ -92,3 +92,12 @@ proxy:
   enabled: false
   host: 20.111.54.16
   port: 8123
+
+springdoc:
+  api-docs:
+    enabled: true
+    path: /doc/v3/api-docs
+  swagger-ui:
+    enabled: true
+    path: /doc/swagger/swagger-ui.html
+    packagesToScan: com.njuzr.eaibackend.controller

pom.xml

@@ -187,6 +187,11 @@
             <version>3.14.2</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.1.0</version>
+        </dependency>
 
     </dependencies>
 

src/main/java/com/njuzr/eaibackend/config/SecurityConfig.java

@@ -58,6 +58,7 @@ public class SecurityConfig {
                                 "/api/user/verifyCode",
                                 "/api/onlyoffice/**",
                                 "/api/assignment/**",
+                                "/doc/**",
                                 "api/auth/loginByPortal").permitAll() // 允许公开访问的路径
                         .anyRequest().authenticated() // 其他所有请求需要认证
                 )

src/main/java/com/njuzr/eaibackend/config/SpringDocConfig.java

@@ -0,0 +1,24 @@
+package com.njuzr.eaibackend.config;
+
+import io.swagger.v3.oas.models.ExternalDocumentation;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * spring doc配置
+ */
+@Configuration
+public class SpringDocConfig {
+    @Bean
+    public OpenAPI restfulOpenAPI() {
+        return new OpenAPI()
+                .info(new Info().title("SEEAI专业英语写作平台API")
+                        .description("Spring Boot3 Restful API")
+                        .version("V1.0.0")
+                        .license(new License().name("访问SpringDoc官方网站").url("http://springdoc.org")));
+    }
+ 
+}

src/main/resources/application-dev.yaml

@@ -67,3 +67,12 @@ proxy:
   enabled: false
   host: 20.111.54.16
   port: 8123
+
+springdoc:
+  api-docs:
+    enabled: true
+    path: /doc/v3/api-docs
+  swagger-ui:
+    enabled: true
+    path: /doc/swagger/swagger-ui.html
+    packagesToScan: com.njuzr.eaibackend.controller

src/main/resources/application-prod.yaml

@@ -67,4 +67,11 @@ proxy:
   host: 20.111.54.16
   port: 8123
 
-
+springdoc:
+  api-docs:
+    enabled: false
+    path: /doc/v3/api-docs
+  swagger-ui:
+    enabled: false
+    path: /doc/swagger/swagger-ui.html
+    packagesToScan: com.njuzr.eaibackend.controller