Add vehicle endpoint

app.ts

@@ -21,6 +21,7 @@ require('./modules/sports/api/sports-routes')(app); // Sports
 require('./modules/users/api/user-routes')(app); //Users
 require('./modules/music/api/music-routes')(app); // Music
 require('./modules/quotes/api/qoutes-routes')(app); // Quotes
+require('./modules/vehicles/api/vehicles-routes')(app); // Vehicles
 
 // Add an healthcheck endpoint
 app.get('/status', (req, res) => {

modules/vehicles/api/vehicles-routes.ts

@@ -0,0 +1,13 @@
+import { Request, Response } from 'express';
+import * as core from 'express-serve-static-core';
+import { getQtyFromRequest } from '../../../utils/route-utils';
+import getRandomVehicles from '../utils/getRandomVehicles';
+
+module.exports = function (app: core.Express) {
+  //Get a randomly generated user
+  app.get('/vehicles/:qty?', (req: Request, res: Response) => {
+    const qty = getQtyFromRequest(req, 1);
+    const users = getRandomVehicles(qty);
+    res.json(users);
+  });
+};

modules/vehicles/consts/Vehicle.ts

@@ -0,0 +1,12 @@
+type Vehicle = {
+  name: string;
+  type: string;
+  color: string;
+  fuel: string;
+  manufacturer: string;
+  model: string;
+  vin: string;
+  vrm: string;
+};
+
+export default Vehicle;

modules/vehicles/utils/getRandomVehicles.ts

@@ -0,0 +1,23 @@
+import Vehicle from '../consts/Vehicle';
+import { faker } from '@faker-js/faker';
+
+const getRandomVehicles = (qty: number) => {
+  const vehicles: Vehicle[] = [];
+
+  Array.from({ length: qty }).forEach(() => {
+    vehicles.push({
+      name: faker.vehicle.vehicle(),
+      type: faker.vehicle.type(),
+      color: faker.vehicle.color(),
+      fuel: faker.vehicle.fuel(),
+      manufacturer: faker.vehicle.manufacturer(),
+      model: faker.vehicle.model(),
+      vin: faker.vehicle.vin(),
+      vrm: faker.vehicle.vrm(),
+    });
+  });
+
+  return vehicles;
+};
+
+export default getRandomVehicles;

swagger.json

@@ -68,6 +68,10 @@
         {
             "name": "Sports",
             "description": "A set of endpoints to get random sports data"
+        },
+        {
+          "name": "Vehicles",
+          "description": "A set of endpoints to get random vehicle data"
         }
     ],
     "paths": {
@@ -1932,6 +1936,28 @@
                     }
                 }
             }
+        },
+        "/vehicles": {
+          "get": {
+            "tags": ["Vehicles"],
+            "summary": "Get a list of all vehicle from the database",
+            "parameters": [
+              {
+                "in": "path",
+                "name": "qty",
+                "default": 1,
+                "description": "The amount of results you would like returned"
+              }
+            ],
+            "responses": {
+              "200": {
+                "description": "OK",
+                "schema": {
+                  "$ref": "#/definitions/MockVehicles"
+                }
+              }
+            }
+          }
         }
     },
     "definitions": {
@@ -2171,6 +2197,46 @@
                     }
                 }
             }
+        },
+        "MockVehicles": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "example": "Jeep Model X"
+              },
+              "type": {
+                "type": "string",
+                "example": "Minivan"
+              },
+              "color": {
+                "type": "string",
+                "example": "tan"
+              },
+              "fuel": {
+                "type": "string",
+                "example": "Hybrid"
+              },
+              "manufacturer": {
+                "type": "string",
+                "example": "Jeep"
+              },
+              "model": {
+                "type": "string",
+                "example": "A8"
+              },
+              "vin": {
+                "type": "string",
+                "example": "NP1WJW8L8WWM52689"
+              },
+              "vrm": {
+                "type": "string",
+                "example": "JX30UEU"
+              }
+            }
+          }
         }
     }
   }