[feat #32] 게이트웨이 Swagger 설정

common/caching/src/main/java/caching/repository/RedisRepository.java

@@ -53,4 +53,16 @@ public void decrement(String key) {
         redisTemplate.opsForValue().decrement(key);
     }
 
+    public Object getValue(String key) {
+        return redisTemplate.opsForValue().get(key);
+    }
+
+    public Long getSortedSetSize(String key) {
+        return redisTemplate.opsForZSet().size(key);
+    }
+
+    public Boolean hasKey(String key) {
+        return redisTemplate.hasKey(key);
+    }
+
 }

common/dtos/src/main/java/user/LoginRequest.java

@@ -0,0 +1,5 @@
+package user;
+
+public record LoginRequest(String email, String password) {
+
+}

docker-compose-redis.yml

@@ -94,4 +94,8 @@ services:
       - redis-master-3
       - redis-replica-1
       - redis-replica-2
-      - redis-replica-3
+      - redis-replica-3
+
+networks:
+  redis:
+    driver: bridge

gateway/build.gradle

@@ -22,21 +22,27 @@ ext {
 }
 
 dependencies {
-	implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
+	implementation project(':common:caching')
+
+	// Cloud
 	implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client'
-	implementation 'org.springframework.boot:spring-boot-starter-security'
 	implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
+	implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
+
+	// Security
+	implementation 'org.springframework.boot:spring-boot-starter-security'
 
 	// JWT
 	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
 	runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
 	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
 
+	// Swagger
+	implementation 'org.springdoc:springdoc-openapi-starter-webflux-ui:2.0.2'
+
 	// Monitoring
 	implementation 'org.springframework.boot:spring-boot-starter-actuator'
 	runtimeOnly 'io.micrometer:micrometer-registry-prometheus'
-
-	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
 }
 
 dependencyManagement {

gateway/src/main/java/com/ticketping/gateway/GatewayApplication.java → gateway/src/main/java/com/ticketPing/gateway/GatewayApplication.java

@@ -1,16 +1,15 @@
-package com.ticketping.gateway;
+package com.ticketPing.gateway;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.openfeign.EnableFeignClients;
 import org.springframework.context.annotation.ComponentScan;
 
+@ComponentScan(basePackages = {"com.ticketPing.gateway", "caching"})
 @EnableFeignClients
 @SpringBootApplication
 public class GatewayApplication {
-
 	public static void main(String[] args) {
 		SpringApplication.run(GatewayApplication.class, args);
 	}
-
 }

gateway/src/main/java/com/ticketping/gateway/application/dto/UserCache.java → gateway/src/main/java/com/ticketPing/gateway/application/dto/UserCache.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.application.dto;
+package com.ticketPing.gateway.application.dto;
 
 import java.util.UUID;
 

gateway/src/main/java/com/ticketping/gateway/application/service/QueueCheckService.java → gateway/src/main/java/com/ticketPing/gateway/application/service/QueueCheckService.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.application.service;
+package com.ticketPing.gateway.application.service;
 
 public interface QueueCheckService {
     boolean areTooManyWaitingUsers(String performanceId);

gateway/src/main/java/com/ticketping/gateway/application/service/QueueCheckServiceImpl.java → gateway/src/main/java/com/ticketPing/gateway/application/service/QueueCheckServiceImpl.java

@@ -1,8 +1,8 @@
-package com.ticketping.gateway.application.service;
+package com.ticketPing.gateway.application.service;
 
-import static com.ticketping.gateway.domain.utils.QueueTokenValueGenerator.generateTokenValue;
+import static com.ticketPing.gateway.domain.utils.QueueTokenValueGenerator.generateTokenValue;
 
-import com.ticketping.gateway.domain.repository.QueueCheckRepository;
+import com.ticketPing.gateway.domain.repository.QueueCheckRepository;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 

gateway/src/main/java/com/ticketping/gateway/domain/repository/QueueCheckRepository.java → gateway/src/main/java/com/ticketPing/gateway/domain/repository/QueueCheckRepository.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.domain.repository;
+package com.ticketPing.gateway.domain.repository;
 
 public interface QueueCheckRepository {
     int getAvailableSeats(String performanceId);

gateway/src/main/java/com/ticketping/gateway/domain/utils/QueueTokenValueGenerator.java → gateway/src/main/java/com/ticketPing/gateway/domain/utils/QueueTokenValueGenerator.java

@@ -1,7 +1,7 @@
-package com.ticketping.gateway.domain.utils;
+package com.ticketPing.gateway.domain.utils;
 
-import static com.ticketping.gateway.infrastructure.enums.RedisKeyPrefix.TOKEN_VALUE;
-import static com.ticketping.gateway.infrastructure.utils.ConfigHolder.tokenValueSecretKey;
+import static com.ticketPing.gateway.infrastructure.enums.RedisKeyPrefix.TOKEN_VALUE;
+import static com.ticketPing.gateway.infrastructure.utils.ConfigHolder.tokenValueSecretKey;
 
 import java.nio.charset.StandardCharsets;
 import java.security.MessageDigest;

gateway/src/main/java/com/ticketping/gateway/exception/ApplicationException.java → gateway/src/main/java/com/ticketPing/gateway/exception/ApplicationException.java

@@ -1,6 +1,6 @@
-package com.ticketping.gateway.exception;
+package com.ticketPing.gateway.exception;
 
-import com.ticketping.gateway.presentation.cases.ErrorCase;
+import com.ticketPing.gateway.presentation.cases.ErrorCase;
 import lombok.Getter;
 
 @Getter

gateway/src/main/java/com/ticketping/gateway/infrastructure/config/GatewayCorsConfiguration.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/config/GatewayCorsConfiguration.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.infrastructure.config;
+package com.ticketPing.gateway.infrastructure.config;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

gateway/src/main/java/com/ticketPing/gateway/infrastructure/config/RouteConfig.java

@@ -0,0 +1,58 @@
+package com.ticketPing.gateway.infrastructure.config;
+
+import com.ticketPing.gateway.infrastructure.config.filter.QueueCheckFilter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.cloud.gateway.route.RouteLocator;
+import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@RequiredArgsConstructor
+public class RouteConfig {
+
+    private final QueueCheckFilter queueCheckFilter;
+
+    @Bean
+    public RouteLocator gatewayRoutes(RouteLocatorBuilder builder) {
+        return builder.routes()
+
+                // API Routing
+                .route("auth-service", r -> r.path("/api/v1/auth/**")
+                        .uri("lb://auth"))
+                .route("user-service", r -> r.path("/api/v1/users/**")
+                        .uri("lb://user"))
+                .route("performance-service", r -> r.path(
+                        "/api/v1/performances/**", "/api/v1/schedules/**", "/api/v1/seats/**")
+                        .uri("lb://performance"))
+                .route("order-service", r -> r.path("/api/v1/orders/**")
+                        .uri("lb://order"))
+                .route("payment-service", r -> r.path("/api/v1/payments/**")
+                        .uri("lb://payment"))
+                .route("queue-manage-service", r -> r.path("/api/v1/waiting-queue/**", "/api/v1/working-queue/**")
+                        .uri("lb://queue-manage"))
+
+                // Swagger Routing
+                .route("auth-docs", r -> r.path("/v3/api-docs/auth-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/auth-service", "/v3/api-docs"))
+                        .uri("lb://auth"))
+                .route("user-docs", r -> r.path("/v3/api-docs/user-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/user-service", "/v3/api-docs"))
+                        .uri("lb://user"))
+                .route("performance-docs", r -> r.path("/v3/api-docs/performance-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/performance-service", "/v3/api-docs"))
+                        .uri("lb://performance"))
+                .route("order-docs", r -> r.path("/v3/api-docs/order-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/order-service", "/v3/api-docs"))
+                        .uri("lb://order"))
+                .route("payment-docs", r -> r.path("/v3/api-docs/payment-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/payment-service", "/v3/api-docs"))
+                        .uri("lb://payment"))
+                .route("queue-manage-docs", r -> r.path("/v3/api-docs/queue-manage-service")
+                        .filters(f -> f.rewritePath("/v3/api-docs/queue-manage-service", "/v3/api-docs"))
+                        .uri("lb://queue-manage"))
+
+                .build();
+    }
+
+}

gateway/src/main/java/com/ticketPing/gateway/infrastructure/config/SwaggerConfig.java

@@ -0,0 +1,39 @@
+package com.ticketPing.gateway.infrastructure.config;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import lombok.RequiredArgsConstructor;
+import org.springdoc.core.properties.SwaggerUiConfigParameters;
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.cloud.gateway.route.RouteLocator;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.util.Objects;
+
+@Configuration
+@RequiredArgsConstructor
+public class SwaggerConfig {
+
+    private final RouteLocator routeLocator;
+
+    @Bean
+    public CommandLineRunner openApiGroups(SwaggerUiConfigParameters swaggerUiParameters) {
+        return args -> Objects.requireNonNull(routeLocator.getRoutes().collectList().block())
+                .stream()
+                .filter(route -> route.getId() != null && !route.getId().contains("-docs")) // API 문서 라우트 제외
+                .forEach(route -> {
+                    String name = route.getId();
+                    swaggerUiParameters.addGroup(name);
+                });
+    }
+
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("TicketPing API")
+                        .version("1.0"));
+    }
+
+}

gateway/src/main/java/com/ticketping/gateway/infrastructure/config/filter/QueueCheckFilter.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/config/filter/QueueCheckFilter.java

@@ -1,12 +1,12 @@
-package com.ticketping.gateway.infrastructure.config.filter;
+package com.ticketPing.gateway.infrastructure.config.filter;
 
-import static com.ticketping.gateway.presentation.cases.FilterErrorCase.PERFORMANCE_SOLD_OUT;
-import static com.ticketping.gateway.presentation.cases.FilterErrorCase.TOO_MANY_WAITING_USERS;
-import static com.ticketping.gateway.presentation.cases.FilterErrorCase.WORKING_TOKEN_NOT_FOUND;
+import static com.ticketPing.gateway.presentation.cases.FilterErrorCase.PERFORMANCE_SOLD_OUT;
+import static com.ticketPing.gateway.presentation.cases.FilterErrorCase.TOO_MANY_WAITING_USERS;
+import static com.ticketPing.gateway.presentation.cases.FilterErrorCase.WORKING_TOKEN_NOT_FOUND;
 
-import com.ticketping.gateway.application.service.QueueCheckService;
-import com.ticketping.gateway.infrastructure.enums.APIType;
-import com.ticketping.gateway.infrastructure.utils.ResponseWriter;
+import com.ticketPing.gateway.application.service.QueueCheckService;
+import com.ticketPing.gateway.infrastructure.enums.APIType;
+import com.ticketPing.gateway.infrastructure.utils.ResponseWriter;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.cloud.gateway.filter.GatewayFilterChain;

gateway/src/main/java/com/ticketping/gateway/infrastructure/enums/APIType.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/enums/APIType.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.infrastructure.enums;
+package com.ticketPing.gateway.infrastructure.enums;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

gateway/src/main/java/com/ticketping/gateway/infrastructure/enums/RedisKeyPrefix.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/enums/RedisKeyPrefix.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.infrastructure.enums;
+package com.ticketPing.gateway.infrastructure.enums;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

gateway/src/main/java/com/ticketping/gateway/infrastructure/repository/QueueCheckRepositoryImpl.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/repository/QueueCheckRepositoryImpl.java

@@ -1,9 +1,10 @@
-package com.ticketping.gateway.infrastructure.repository;
+package com.ticketPing.gateway.infrastructure.repository;
 
-import static com.ticketping.gateway.infrastructure.enums.RedisKeyPrefix.AVAILABLE_SEATS;
-import static com.ticketping.gateway.infrastructure.enums.RedisKeyPrefix.WAITING_QUEUE;
+import static com.ticketPing.gateway.infrastructure.enums.RedisKeyPrefix.AVAILABLE_SEATS;
+import static com.ticketPing.gateway.infrastructure.enums.RedisKeyPrefix.WAITING_QUEUE;
 
-import com.ticketping.gateway.domain.repository.QueueCheckRepository;
+import caching.repository.RedisRepository;
+import com.ticketPing.gateway.domain.repository.QueueCheckRepository;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Repository;
 

gateway/src/main/java/com/ticketping/gateway/infrastructure/security/JwtFilter.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/security/JwtFilter.java

@@ -1,10 +1,10 @@
-package com.ticketping.gateway.infrastructure.security;
+package com.ticketPing.gateway.infrastructure.security;
 
-import com.ticketping.gateway.application.dto.UserCache;
-import com.ticketping.gateway.exception.ApplicationException;
-import com.ticketping.gateway.infrastructure.repository.RedisRepository;
-import com.ticketping.gateway.infrastructure.utils.ResponseWriter;
-import com.ticketping.gateway.presentation.cases.SecurityErrorCase;
+import caching.repository.RedisRepository;
+import com.ticketPing.gateway.application.dto.UserCache;
+import com.ticketPing.gateway.exception.ApplicationException;
+import com.ticketPing.gateway.infrastructure.utils.ResponseWriter;
+import com.ticketPing.gateway.presentation.cases.SecurityErrorCase;
 import io.jsonwebtoken.*;
 import io.jsonwebtoken.security.Keys;
 import org.springframework.beans.factory.annotation.Value;

gateway/src/main/java/com/ticketping/gateway/infrastructure/security/SecurityConfig.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/security/SecurityConfig.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.infrastructure.security;
+package com.ticketPing.gateway.infrastructure.security;
 
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.annotation.Bean;
@@ -27,10 +27,11 @@ public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
                         .pathMatchers("/api/v1/users/signup").permitAll()
                         .pathMatchers(HttpMethod.GET, "/api/v1/performances/**").permitAll()
                         .pathMatchers(HttpMethod.GET, "/api/v1/schedules/{scheduleId}").permitAll()
-                        .pathMatchers("/api/v1/payments/**").permitAll()
                         .pathMatchers("/actuator/prometheus").permitAll()
-                        .anyExchange().authenticated()  // 그 외 모든 경로는 인증 필요
+                        .pathMatchers("/swagger-ui/**", "/v3/api-docs/**", "/webjars/**").permitAll()
+                        .anyExchange().permitAll()
                 )
                 .build();
     }
+
 }

gateway/src/main/java/com/ticketping/gateway/infrastructure/utils/ConfigHolder.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/utils/ConfigHolder.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.infrastructure.utils;
+package com.ticketPing.gateway.infrastructure.utils;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;

gateway/src/main/java/com/ticketping/gateway/infrastructure/utils/ResponseWriter.java → gateway/src/main/java/com/ticketPing/gateway/infrastructure/utils/ResponseWriter.java

@@ -1,8 +1,8 @@
-package com.ticketping.gateway.infrastructure.utils;
+package com.ticketPing.gateway.infrastructure.utils;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.ticketping.gateway.presentation.response.CustomErrorResponse;
-import com.ticketping.gateway.presentation.cases.FilterErrorCase;
+import com.ticketPing.gateway.presentation.response.CustomErrorResponse;
+import com.ticketPing.gateway.presentation.cases.FilterErrorCase;
 import lombok.RequiredArgsConstructor;
 import org.springframework.core.io.buffer.DataBufferFactory;
 import org.springframework.http.MediaType;

gateway/src/main/java/com/ticketping/gateway/presentation/cases/ErrorCase.java → gateway/src/main/java/com/ticketPing/gateway/presentation/cases/ErrorCase.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.presentation.cases;
+package com.ticketPing.gateway.presentation.cases;
 
 import org.springframework.http.HttpStatus;
 

gateway/src/main/java/com/ticketping/gateway/presentation/cases/FilterErrorCase.java → gateway/src/main/java/com/ticketPing/gateway/presentation/cases/FilterErrorCase.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.presentation.cases;
+package com.ticketPing.gateway.presentation.cases;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

gateway/src/main/java/com/ticketping/gateway/presentation/cases/SecurityErrorCase.java → gateway/src/main/java/com/ticketPing/gateway/presentation/cases/SecurityErrorCase.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.presentation.cases;
+package com.ticketPing.gateway.presentation.cases;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

gateway/src/main/java/com/ticketping/gateway/presentation/response/CustomErrorResponse.java → gateway/src/main/java/com/ticketPing/gateway/presentation/response/CustomErrorResponse.java

@@ -1,4 +1,4 @@
-package com.ticketping.gateway.presentation.response;
+package com.ticketPing.gateway.presentation.response;
 
 import org.springframework.http.HttpStatus;