Merge pull request #211 from learnsoftwaredevelopment/improved-search-software-api-endpoint

Improved `search` software API endpoint

Author: JonathanLeeWH

controllers/api/searchController.js

@@ -1,14 +1,26 @@
 const Software = require('../../models/software');
 
 const searchSoftware = async (req, res) => {
-  const { name } = req.query;
-  const response = await Software.find({
+  const page = parseInt(req.query.page, 10) || 0;
+  const perPage = parseInt(req.query.per_page, 10) || 30;
+  const query = {
     name: {
-      $regex: name,
+      $regex: req.query.q,
       $options: 'i',
     },
+  };
+
+  const queryResponse = await Software.find(query)
+    .sort({ name: 'asc' })
+    .skip(page * perPage)
+    .limit(perPage);
+
+  const totalQueryResultCount = await Software.find(query).countDocuments();
+
+  return res.status(200).json({
+    totalQueryResultCount,
+    queryResponse,
   });
-  return res.status(200).json(response);
 };
 
 module.exports = {

models/software.js

@@ -34,9 +34,10 @@ const softwareSchema = new mongoose.Schema(
     homePage: {
       type: String,
       validate: [
-        (value) => isURL(value, {
-          protocols: ['http', 'https'],
-        }),
+        (value) =>
+          isURL(value, {
+            protocols: ['http', 'https'],
+          }),
         'A valid url is required',
       ],
       required: [true, 'Software homepage url is required'],
@@ -64,17 +65,19 @@ const softwareSchema = new mongoose.Schema(
     developedBy: {
       type: [
         {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: 'User',
+          type: String,
+          trim: true,
+          lowercase: true,
         },
       ],
       default: [],
     },
     maintainedBy: {
       type: [
         {
-          type: mongoose.Schema.Types.ObjectId,
-          ref: 'User',
+          type: String,
+          trim: true,
+          lowercase: true,
         },
       ],
       default: [],
@@ -87,19 +90,21 @@ const softwareSchema = new mongoose.Schema(
       updateUrl: {
         type: String,
         validate: [
-          (value) => isURL(value, {
-            protocols: ['http', 'https'],
-          }) || value === '',
+          (value) =>
+            isURL(value, {
+              protocols: ['http', 'https'],
+            }) || value === '',
           'A valid update url is required',
         ],
         default: '',
       },
       downloadUrl: {
         type: String,
         validate: [
-          (value) => isURL(value, {
-            protocols: ['http', 'https', 'ftp'],
-          }) || value === '',
+          (value) =>
+            isURL(value, {
+              protocols: ['http', 'https', 'ftp'],
+            }) || value === '',
           'A valid download url is required',
         ],
         default: '',

requests/api/softwares/search_software.rest

@@ -1 +1 @@
-GET http://localhost:3001/api/search/software?name=sample
+GET http://localhost:3001/api/search/software?q=sample&per_page=1&page=0