Merge pull request #292 from sixwaaaay/condition

feat: add conditional openapi document

Author: sixwaaaay

.github/workflows/comment.yaml

@@ -69,7 +69,7 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Build Binary Executable
-        run: mvn clean &&  mvn -Pnative -Pproduction native:compile -DskipTests
+        run: mvn clean && mvn -Pnative -Pproduction native:compile -DskipTests -P!openapi
 
       - name: Upload build artifacts
         run: |

graal/pom.xml

@@ -12,8 +12,8 @@
   ~ limitations under the License.
   -->
 
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>org.springframework.boot</groupId>
@@ -194,5 +194,19 @@
             </plugin>
         </plugins>
     </build>
-
+    <profiles>
+        <profile>
+            <id>openapi</id>
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+            <dependencies>
+                <dependency>
+                    <groupId>org.springdoc</groupId>
+                    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+                    <version>2.3.0</version>
+                </dependency>
+            </dependencies>
+        </profile>
+    </profiles>
 </project>

graal/src/main/java/io/sixwaaaay/sharingcomment/config/SecurityConfig.java

@@ -29,6 +29,12 @@
 @Configuration
 public class SecurityConfig {
 
+
+    /**
+     * configure user detail service
+     *
+     * @return user detail service
+     */
     @Bean
     UserDetailsService emptyDetailsService() {
         return username -> {
@@ -37,6 +43,13 @@ UserDetailsService emptyDetailsService() {
     }
 
 
+    /**
+     * configure security filter chain
+     *
+     * @param http        http security builder
+     * @param tokenParser token parser
+     * @return security filter chain
+     */
     @Bean
     @SneakyThrows
     public SecurityFilterChain filterChain(HttpSecurity http, TokenParser tokenParser) {
@@ -55,8 +68,12 @@ public SecurityFilterChain filterChain(HttpSecurity http, TokenParser tokenParse
                                 "/comments/main",
                                 "/comments/reply"
                         ).permitAll()
+                        .requestMatchers(HttpMethod.GET, "/api*")
+                        .permitAll()
                 ).addFilterBefore(new ServiceInterceptor(tokenParser), UsernamePasswordAuthenticationFilter.class)
+                /* disable default session management */
                 .sessionManagement(smc -> smc.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
+                /* disable default csrf protection */
                 .csrf(AbstractHttpConfigurer::disable);
         return http.build();
     }

graal/src/main/resources/application.yaml

@@ -49,6 +49,9 @@ management:
         version: 1.0.0-snapshot
 cache:
   ttl: 5 # 10 seconds
+springdoc:
+  api-docs:
+    path: /api-docs
 service:
   vote:
     enabled: true