feat(docs): ✨ add swagger docs

Author: mcnaveen

README.md

@@ -121,6 +121,14 @@ OR
 Project - Give Forked Repo URL - Go Live
 ```
 
+## 🔐 Rate Limit
+
+- To configure the rate limit, edit the `utils/index.js` file
+- Look for `limiter` variable
+- `max` is the maximum number of requests allowed in a given time window
+- `windowMs` is the time window in milliseconds
+- `message` is the message to be returned when the rate limit is exceeded
+
 ## 😇 Add New Language
 - Create a new folder in `data` with the full language name `ex: english`
 - Add the words in the `words.json` file

app.json

@@ -1,6 +1,6 @@
 {
-    "name": "wotd",
-    "description": "Word of the Day.",
+    "name": "random-words-api",
+    "description": "API for getting random words in different languages",
     "repository": "https://github.com/mcnaveen/Random-Words-API",
-    "keywords": ["expressjs", "nodejs", "json"]
+    "keywords": ["expressjs", "nodejs", "json", "random-words", "api"]
 }

index.js

@@ -1,13 +1,23 @@
 import express from "express";
 const app = express();
 
-import home from './routes/home.js';
 import english from './routes/english.js';
 import language from './routes/language.js';
+import swaggerUi from './swagger-ui.js';
+import { limiter } from "./utils/index.js";
 
-app.use('/', home);
+// Apply rate limiter to all routes except root
+app.use((req, res, next) => {
+  if (req.path !== '/') {
+    return limiter(req, res, next);
+  }
+  next();
+});
+
+app.use('/', swaggerUi);
 app.use('/word', english);
 app.use('/word', language);
+app.use('/api-docs', swaggerUi);
 
 app.use('/', function(_req, res) {
     res.status(404).json({

package.json

@@ -1,16 +1,19 @@
 {
-	"name": "wotd",
+	"name": "random-words-api",
 	"version": "1.0.0",
-	"description": "Word of the Day",
+	"description": "API for getting random words in different languages",
 	"private": true,
 	"main": "index.js",
 	"dependencies": {
 		"axios": "^1.1.3",
 		"cheerio": "^1.0.0-rc.12",
 		"express": "^4.18.2",
+		"express-rate-limit": "^7.4.0",
 		"node-pronounce": "^0.0.4",
 		"random-array-item": "^0.0.2",
-		"random-useragent": "^0.5.0"
+		"random-useragent": "^0.5.0",
+		"swagger-jsdoc": "^6.2.8",
+		"swagger-ui-express": "^5.0.1"
 	},
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",