Browse Source

新增文档

tsurumure 10 months ago
parent
commit
7ea6d298e8

+ 6 - 0
pom.xml

@@ -400,6 +400,12 @@
 <!--            <scope>test</scope>-->
 <!--        </dependency>-->
 
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.6.0</version>
+        </dependency>
+
     </dependencies>
 
 

+ 1 - 0
src/main/java/com/backendsys/config/Interceptor/PreAuthorizeInterceptor.java

@@ -13,6 +13,7 @@ public class PreAuthorizeInterceptor implements HandlerInterceptor {
     
     @Override
     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
+
         HandlerMethod handlerMethod = (HandlerMethod) handler;
         Method method = handlerMethod.getMethod();
 

+ 4 - 1
src/main/java/com/backendsys/config/Security/CorsConfig.java

@@ -30,7 +30,10 @@ public class CorsConfig implements WebMvcConfigurer {
 
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
-        registry.addInterceptor(preAuthorizeInterceptor).addPathPatterns("/**");
+        registry.addInterceptor(preAuthorizeInterceptor)
+                .addPathPatterns("/**")
+                .excludePathPatterns("/swagger-ui/**")
+        ;
     }
 
     @Override

+ 1 - 0
src/main/java/com/backendsys/config/Security/SecurityConfig.java

@@ -73,6 +73,7 @@ public class SecurityConfig {
                 authorizeHttpRequests
                     .requestMatchers(whitelist).permitAll()
                     .anyRequest().authenticated()
+//                    .anyRequest().permitAll() // 开放所有
             )
 
             // "/api/auth/login",

+ 22 - 1
src/main/resources/application.yml

@@ -83,7 +83,10 @@ whitelist:
     /*.html,
     /*.ico,
     /images/**,
-    /uploads/**
+    /uploads/**,
+    /swagger-ui/index.html,
+    /swagger-ui/**,
+    /v3/**
   jwt:
     /api/webhook,
     /api/public/**,
@@ -139,3 +142,21 @@ management:
 #  username: 用户名称已存在
 #  nickname: 昵称已存在
 #  role_name: 角色名称已存在
+
+
+
+springdoc:
+  api-docs:
+    enabled: true #
+#    path: /api-docs # 默认/v3/api-docs # 样式
+
+#  swagger-ui:
+#    path: /swagger-ui.html #自定义swagger-ui HTML文档路径
+
+#group-configs: #进行文档分组每个组配置对应的请求路径以及区分所在包
+#  - group: 'user'
+#    paths-to-match: '/api/users/**'
+#    packages-to-scan: com.toher.springdoc.user
+#  - group: 'product'
+#    paths-to-match: '/api/product/**'
+#    packages-to-scan: com.toher.springdoc.product