Genesis commit

Author: rslsystems

.env.example

@@ -0,0 +1,3 @@
+SERVER_NAME=mock-json-server
+SERVER_PORT=3000
+SERVER_PREFIX=v1

.gitignore

@@ -0,0 +1,5 @@
+/.idea
+/.vscode
+.env
+app/data/*
+!app/data/.gitkeep

Dockerfile

@@ -0,0 +1,18 @@
+FROM node:16.16.0-alpine
+
+USER root
+WORKDIR /usr/local
+COPY *.json ./
+COPY *.js ./
+
+RUN npm install
+ENV PATH /usr/local/node_modules/.bin:$PATH
+
+WORKDIR /usr/local/app
+COPY app ./
+
+EXPOSE 3000
+USER node
+
+#ENTRYPOINT ["tail", "-f", "/dev/null"]
+CMD ["npm", "start"]

README.md

@@ -0,0 +1,76 @@
+# Mock API Server  
+Based on [json-server](https://github.com/typicode/json-server)
+
+## Getting Started
+There is a couple of environment variables that can be set if you want to over-ride the defaults
+
+| Name          | Description                     | Default          |
+|---------------|---------------------------------|------------------|
+| SERVER_NAME   | Prefix for the docker conatiner | mock-json-server |
+| SERVER_PORT   | Exposed port for the sever      | 3000             | 
+| SERVER_PREFIX | Prefix for the urls             | v1               |
+
+If you want to change these, copy the _.env.example_ file to _.env_ and set the values  
+```shell
+cp .env.example .env
+```
+
+Once your environment is set, bring up the container like you would any docker-compose poroject;
+```shell
+docker-compose build
+docker-compose up -d
+```
+and
+```shell
+docker-compose down
+```
+when you are done.
+
+## Managing Your Data
+Your data is stored in _json_ files located in the `app/data` folder.  
+Example:  
+```json
+[
+  { "id": 1, "name": "wibble", "age": "20" },
+  { "id": 2, "name": "wabble", "age": "30" },
+  { "id": 3, "name": "wubble", "age": "40" }
+]
+```
+This setup works by automatically reading all the json files in the data folder.  
+You can add/edit them without bringing down the container.
+
+N.B. These files are more of a seed in concept.  
+If you use a `POST` route, the new data will not show up in the file.
+
+To see the whole database at any time just hit up the database endpoint.
+```shell
+GET /db
+```
+
+For more information see the json-server [docs](https://github.com/typicode/json-server#getting-started)
+## Managing your routes
+As per the standard [json-server](https://github.com/typicode/json-server#routes), routes are automatically created based on the names of the data files.  
+So a data file called `posts.json`, will have the endpoints;
+```shell
+GET    /posts
+GET    /posts/1
+POST   /posts
+PUT    /posts/1
+PATCH  /posts/1
+DELETE /posts/1
+```
+
+They are also available using the environment prefix variable.  
+```shell
+GET    /v1/posts
+GET    /v1/posts/1
+POST   /v1/posts
+PUT    /v1/posts/1
+PATCH  /v1/posts/1
+DELETE /v1/posts/1
+```
+
+You can add your own custom routes in the `data/routes.js` file.  
+See the main [json-server](https://github.com/typicode/json-server#add-custom-routes) documentation for more details.
+
+# Have fun

app/data/.gitkeep

@@ -0,0 +1,3 @@
+module.exports = {
+  "/:resource/:id/show": "/:resource/:id"
+}

app/routes.js

@@ -0,0 +1,19 @@
+const {readdirSync, readFileSync} = require("fs");
+const path = require('path')
+
+let data = {}
+let dataDirectory = "app/data";
+let files = readdirSync(dataDirectory);
+
+files.forEach((file) => {
+    try {
+        const name = path.parse(file).name
+        const filepath = path.resolve(dataDirectory, file)
+
+        data[name] = JSON.parse(readFileSync(filepath, 'utf8'))
+    } catch (err) {
+        console.error(err)
+    }
+});
+
+module.exports = data

data.js

@@ -0,0 +1,20 @@
+version: "3.8"
+
+services:
+  app:
+    container_name: ${SERVER_NAME:-mock-json-server}
+    build:
+      context: .
+    ports:
+      - ${SERVER_PORT:-3000}:3000
+    environment:
+      - SERVER_PORT=${SERVER_PORT:-3000}
+      - SERVER_PREFIX=${SERVER_PREFIX:-v1}
+    volumes:
+      - ./app:/usr/local/app
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:3000/healthcheck || exit 1
+      interval: 60s
+      retries: 1
+      start_period: 20s
+      timeout: 10s

docker-compose.yml

@@ -0,0 +1,57 @@
+const jsonServer = require('json-server')
+
+let isAuthenticated = true;
+const data = require('./data.js')
+const routes = require('./app/routes.js')
+
+const server = jsonServer.create()
+const router = jsonServer.router(data)
+const middlewares = jsonServer.defaults()
+
+server.use(jsonServer.bodyParser);
+
+// auth middleware
+server.use( function ( req, res, next ) {
+    if (req.url == '/healthcheck') {
+        res.status( 200 ).send( "ok" )
+    } else {
+        next()
+    }
+})
+
+server.use( function ( req, res, next ) {
+    if (isAuthenticated) {
+        next()
+    } else {
+        res.status( 401 ).send( "Unauthorized!" )
+    }
+} );
+
+// the logout endpoint
+server.get( '/logout', function ( req, res ) {
+    isAuthenticated = false;
+    res.status(200).send("logged out");
+} );
+
+server.use(middlewares)
+
+// merge routes into default prefix
+const prefix = `/${process.env.SERVER_PREFIX}/*`
+const defaultRoutes = {}
+defaultRoutes[prefix] = "/$1"
+
+server.use(jsonServer.rewriter({...defaultRoutes, ...routes}));
+
+
+server.use(router)
+
+// Avoid CORS issue
+// server.use( (req, res, next) => {
+//   res.header("Access-Control-Allow-Origin", "*");
+//   // res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
+//   next();
+// });
+
+server.listen(3000, () => {
+    console.log(`JSON Server is running, see http://localhost:${process.env.SERVER_PORT}`)
+})

index.js

@@ -0,0 +1,3 @@
+{
+  "host": "0.0.0.0"
+}