docs: Read.md 문서 작성

Author: jay-so

README.md

@@ -7,3 +7,75 @@
 <br/>
 
 ## 🛠️ 사용 SW
+
+---
+
+![slidingwindowlog.png](slidingwindowlog.png)
+
+<br/>
+
+## 🏢 아키텍처 구조
+
+---
+
+
+```
+├── common 패키지
+│    └── config 패키지
+│          └── RedisConfig.class
+│
+│    └── dto 패키지
+│          └── ExceptionResponse.class
+│    └── exception 패키지
+│          └── BusinessException.class
+│          └── CommonException.class
+│          └── CommonExceptionCode.enum
+│          └── ExceptionCode.interface
+│          └── GlobalExceptionHandler.class
+│
+├── Controller 패키지
+│    └── SlidingWindowLogController.class
+│
+├── dto 패키지
+│    └── response 패키지
+│          └── SlidingWindowLogProfileResponse.class
+│          └── SlidingWindowLogResponse.class
+│
+├── exception 패키지
+│    └── RateException.class
+│    └── RateLimitExceededException.enum
+│
+├── service 패키지
+│     └── SlidingWindowLogService.class
+│ 
+└──  SlidingWindowLogApplication.class
+
+```
+
+<br/>
+
+## ✏️ API 설명
+
+---
+
+### 1️⃣ 이동 윈도 로깅 생성 API
+- 이동 윈도 로깅 생성 API는 이동 윈도 로깅 알고리즘을 구현한 API입니다.
+- 이동 윈도 로깅 생성 API는 요청을 받으면 Redis에 이동 윈도 카운터를 생성하고 요청 횟수를 증가시킵니다.
+- - 각 카운터는 고유한 **윈도 기간(60초)** 동안 유효하며, 이 기간 내의 요청 수를 카운트합니다.
+- 요청 수가 **고정된 최대 요청 허용 수(1000회)** 를 초과하면, 요청은 제한됩니다.
+- 요청이 성공적으로 처리되면, 현재 요청 카운터의 키와 요청 수를 반환합니다.
+
+``` Http
+POST /sliding-window-log
+```
+
+<br/>
+
+### 2️⃣ 이동 윈도 로깅 조회 API
+- 생성된 이동 윈도 로깅의 정보를 조회하는 API입니다.
+- **모든 유효한 이동 윈도 로깅의 키와 해당 키의 요청 수를 조회할 수 있습니다.**
+- **Redis에서 이동 윈도 로깅 카운터를 스캔하여, 각 카운터의 현재 요청 수와 함께 반환**합니다.
+
+``` Http
+GET /sliding-window-log
+```

slidingwindowlog.png

@@ -16,7 +16,7 @@ public class RedisConfig {
     public ReactiveRedisTemplate<String, Object> reactiveRedisTemplate(ReactiveRedisConnectionFactory connectionFactory) {
         ObjectMapper objectMapper = new ObjectMapper();
         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
-        objectMapper.activateDefaultTyping(objectMapper.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.EVERYTHING, JsonTypeInfo.As.PROPERTY); // 모든 객체 타입에 대한 정보를 포함
+        objectMapper.activateDefaultTyping(objectMapper.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.EVERYTHING, JsonTypeInfo.As.PROPERTY);
 
         RedisSerializer<Object> redisSerializer = new GenericJackson2JsonRedisSerializer(objectMapper);