본문 바로가기

springboot7

[springdoc-openapi] 고정 header 설정하기 서버 API 문서화 시 주로 간편한 설정과 직접 요청을 보낼 수 있는 UI를 제공하는 Swagger UI를 주로 사용한다. 하지만 실서비스 용 서버는 주로 인증 기능이 붙어있기 때문에 API 요청 시 인증 용 토큰 등이 필요한 경우가 대다수이다. 이번 포스팅에서는 springdoc-openapi를 사용하여 Swagger UI를 구성할 때, header 기반 인증을 처리하는 방법 중 하나로 고정 header를 설정하는 방법에 대해 알아보겠다. (org.springdoc:springdoc-openapi-ui:1.6.14 기준) (코드 예제는 여기에서 확인할 수 있다) ※ 참고 Springfox는 현재 maintain이 되고있지 않기 때문에, 되도록 springdoc-openapi를 사용하는 것을 추천한다. .. 2022. 12. 31.
Request Rate Limiting with Spring Cloud Gateway - 부록. custom Filter 만들기 기본으로 제공되는 RequestRateLimiter 필터를 사용하게 되면 사용률 제한에 걸리지 않은 요청에 대해서는 문제없지만, 제한이 걸린 요청에 대해 우리 서비스 내부적으로 사용하는 응답 포맷을 사용할 수 없다. 그렇기 때문에 응답 포맷을 항상 지정된 형태로 주어야한다면 RequestRateLimiter를 그대로 사용하기는 힘들고, custom filter를 만들어서 이를 RequestRateLimiter 대신 사용해야할 것이다. 아래는 RedisRateLimiter를 사용하는 custom 사용률 제한 필터의 예제 코드다. (링크) 여기서 Spring Cloud Gateway의 RateLimiter를 사용하기위해 Config 클래스는 HasRouteId 를 상속받아 Router의 ID를 받을 수 있도.. 2022. 2. 8.
Request Rate Limiting with Spring Cloud Gateway - 3. RateLimiterFilter 파헤치기 이전 포스팅에서 Spring Cloud Gateway에서 제공하는 RateLimiterFilter를 사용하여 Request Rate Limiting 기능을 적용하는 방법에 대해 알아보았다. 이번 포스팅에서는 내부적으로 어떤 식으로 RateLimiterFilter가 Request Rate Limiting 기능을 하는지에 대해 파헤쳐보도록하자. 전체 코드는 여기에서 확인 가능하다. RateLimiterFilter application.yml 에서 설정한 RateLimiterFilter는 RequestRateLimiterGatewayFilterFactory 를 살펴보면 된다. 이 필터의 apply 메서드가 리턴하는 GatewayFilter 코드를 보면 전체적인 틀을 파악할 수 있다. RequestRateLim.. 2022. 2. 8.
Request Rate Limiting with Spring Cloud Gateway - 2. RequestRateLimiter 필터 적용 앞서 개요에서 Spring Cloud Gateway에서 기본적으로 Request Rate Limiting 기능을 제공한다고 하였다. 이번 포스팅에서는 Spring Cloud Gateway에서 기본적으로 제공하는 Request Rate Limiting 기능과 이를 사용하는 방법에 대해 알아보도록 하겠다. 전체 코드는 여기에서 확인 가능하다. RequestRateLimiterFatewayFilterFactory in Spring Cloud Gateway Spring Cloud Gateway에서 기본적으로 제공하는 Request Rate Limiting에 대한 필터는 org.springframework.cloud.gateway.filter.factory.RequestRateLimiterGatewayFilter.. 2022. 2. 3.
Request Rate Limiting with Spring Cloud Gateway - 1. 기본 프로젝트 생성 전체 코드는 여기에서 확인 가능하다. 예제는 기존 시스템 구성에 Request Rate Limiting 기능을 추가하는 식으로 진행할 것이다. 그러기 위해서는 앞서 말한 기존 시스템을 구성할 것이다. 어느정도 현실성 있는 예제를 위해 API Gateway에서 인증을 확인하는 기능을 추가하였다. Request Rate Limiting 기능은 이 바탕으로 추가할 것이다. API 서버 먼저 API 서버를 생성해보자. 프로젝트 생성 Spring Web dependency만 추가한 SpringBoot 프로젝트를 생성한다. Controller 추가 그리고 요청을 처리하기 위해 Controller를 추가한다. 이 API 서버는 단순하게 하나의 endpoint를 통해 모든 GET 요청을 처리하도록 처리하였다. pack.. 2022. 1. 30.
Request Rate Limiting with Spring Cloud Gateway - 0. 개요 MSA 환경이라면 클라이언트가 직접 API 서버와 통신하기 보다는 아래 그림과 같이 API Gateway를 통해 클라이언트와 API 서버가 통신을 하게 될 것이다. API 서버 앞 단에위치하는 API Gateway 특성 상 보안이나 요청 로깅 등의 미들웨어 기능을 담당하기도 한다. 같은 맥락에서 API Gateway를 운용할 때, 클라이언트 요청에 대해 요청량 제한을 거는 Request Rate Limiting 기능도 API Gateway에서 처리하는 것이 일반적이다. Spring Cloud 프로젝트에서 제공하는 API Gateway인 Spring Cloud Gateway에서도 Request Rate Limiting 기능을 기본적으로 제공하고 있다. 이번 포스팅 시리즈는 Spring Cloud Gate.. 2022. 1. 30.