chore: rate limit for api (#25)

README.md

@@ -19,13 +19,16 @@ This is a lightweight and timezone-aware date utility package built on top of th
 - Calculate the time difference (in hours) between two timezones.
 - Supports for both JavaScript and TypeScript developer.
 
+There are many more features available in the package.
+
 ## Download/install
 
 [Download/install instructions](https://shivam-sharma7.github.io/world-clockify/#/./guide/installation)
 
 ## Documentation
 
 - [General documentation](https://shivam-sharma7.github.io/world-clockify/#/)
+- [API documentation](https://shivam-sharma7.github.io/world-clockify/#/./api/Introduction)
 
 ## Development
 

api/package.json

@@ -17,6 +17,7 @@
   "dependencies": {
     "dotenv": "^16.4.5",
     "express": "^4.21.1",
+    "express-rate-limit": "^7.4.1",
     "world-clockify": "^1.4.3"
   },
   "devDependencies": {

api/src/middleware/ratelimit.ts

@@ -0,0 +1,10 @@
+import { rateLimit } from 'express-rate-limit';
+
+export const limiter = rateLimit({
+  windowMs: 5 * 60 * 1000, // 5 minutes
+  limit: 10, // each IP can make up to 10 requests per `windowsMs` (5 minutes)
+  standardHeaders: true, // add the `RateLimit-*` headers to the response
+  legacyHeaders: false, // remove the `X-RateLimit-*` headers from the response
+  message: 'Too many requests, please try again later',
+  statusCode: 429,
+});

api/src/routes/timezone.routes.ts

@@ -11,18 +11,19 @@ import {
   fetchSupportedCalendar,
   countDownToEvent,
 } from '../controllers/timezone.controller';
+import { limiter } from '../middleware/ratelimit';
 
 const router = express.Router();
 
 router.get('/currenttime', fetchCurrentTimeInZone);
-router.get('/supportedtimezone', fetchSupportedTimezones);
+router.get('/supportedtimezone', limiter, fetchSupportedTimezones);
 router.get('/currency', fetchSupportedCrrency);
 router.get('/calendar', fetchSupportedCalendar);
-router.get('/converttimezone', fetchConvertedTime);
+router.get('/converttimezone', limiter, fetchConvertedTime);
 router.get('/timedifference', fetchTimeDifference);
-router.get('/calculateduration', calculateDurationBetweenDates);
-router.get('/formattimezone', formatDateInTimezone);
-router.get('/formatdatelocale', formatDateLocale);
-router.get('/countdownevent', countDownToEvent);
+router.get('/calculateduration', limiter, calculateDurationBetweenDates);
+router.get('/formattimezone', limiter, formatDateInTimezone);
+router.get('/formatdatelocale', limiter, formatDateLocale);
+router.get('/countdownevent', limiter, countDownToEvent);
 
 export default router;