[UPDATE] Markup

Author: arashyeganeh

README.md

@@ -0,0 +1,57 @@
+# JSON Server API
+
+A lightweight Node.js application that serves an API from a file-based JSON structure. It dynamically generates API routes based on the folder structure, making it easy to create and manage mock APIs without a database.
+
+## Features
+* Serves JSON data as an API
+* Folder-based dynamic routing
+* Built-in caching for improved performance
+* Middleware for logging and security headers
+* Supports static file serving and EJS templating
+
+## Installation
+
+```sh
+git clone https://github.com/yourusername/json-serve-api.git
+cd json-serve-api
+npm install
+```
+
+###  Usage
+
+```sh
+npm start
+```
+
+By default, the server runs on `http://localhost:3001`.
+
+###  API Structure
+
+Place your JSON files inside the api folder. The folder structure determines the API routes.
+
+For example, given the following structure:
+
+```sh
+api/
+  users/
+    list.json
+    details.jsonYou can access:
+```
+
+You can access:
+
+- GET /api/users/list → Returns list.json
+- GET /api/users/details → Returns details.json
+
+### Middleware
+
+The application includes:
+
+* Logging: Logs incoming requests
+* Security Headers: Adds basic security headers
+* Compression: Enables Gzip compression
+* Static File Serving: Serves files from the public folder
+## Configuration
+Set PORT in the environment variables to change the server port.
+## License
+This project is licensed under the MIT License.

app.js

@@ -28,12 +28,13 @@ function handleHeaders(req, res, next) {
   next();
 }
 
-app.use(cache('5 minutes'));
+// app.use(cache('5 minutes'));
 app.use(express.static(publicDir));
 app.use(express.json());
 app.use(compression())
 app.use(handleLog);
 app.use(handleHeaders);
+app.set('view engine', 'ejs');
 app.use('/', homeRoute);
 app.use('/api/', apiRoute);
 app.use('*', notFoundRoute);

module/fs.js

@@ -30,11 +30,14 @@ function getFiles(targetDir = apiBaseDir) {
         if (entry.isDirectory()) {
           explore(entryPath);
         } else if (entry.isFile()) {
-          const getParentDir = entry.path.replace(path.resolve('api'), '');
+          const parentDir = entry.path
+            .replace(path.resolve('api'), '')
+            .replace(/\\/g, '/');
+          const name = entry.name.split('.')[0];
+
           fileList.push({
-            name: entry.name.split('.')[0],
             path: entryPath,
-            parentPath: getParentDir
+            url: parentDir + '/' + name,
           });
         }
       }

package.json

@@ -1,18 +1,18 @@
 {
   "private": false,
-  "name": "json-serve-api",
+  "name": "json-server-api",
   "version": "0.1.0",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/arashyeganeh/json-serve-api/issues"
+    "url": "https://github.com/arashyeganeh/json-server-api/issues"
   },
   "author": {
     "name": "Arash Yeganeh",
     "url": "https://github.com/arashyeganeh"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arashyeganeh/json-serve-api.git"
+    "url": "https://github.com/arashyeganeh/json-server-api.git"
   },
   "scripts": {
     "dev": "nodemon app.js",
@@ -35,5 +35,8 @@
     "#module/*": "./module/*",
     "#route/*": "./route/*",
     "#app.js": "./app.js"
+  },
+  "nodemonConfig": {
+    "ext": "js,json,ejs,html,css"
   }
 }

public/apple-touch-icon.png

@@ -0,0 +1,21 @@
+{
+  "name": "JSON Server API",
+  "short_name": "",
+  "icons": [
+    {
+      "src": "/web-app-manifest-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "/web-app-manifest-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    }
+  ],
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}