如何使用书架根据API网址中查询字符串中传递的参数过滤数据？

Question

I have created the REST API in Express using Bookshelf which fetches the list of all contributors as JSON

Say API :

GET example.com/contributors

I need to make the filter and pagination for the API, The filter options can be any

GET example.com/contributors?status=1&type=pro

So it will return all the data whose status =1 and type = 'pro',

I am able to get this filtered data using where clause

Model.Contributors.forge()
.query({where: {status: query_params.status, type: query_params.type}})
.fetch()

What I am looking ?

But here the 'where' key values have to be specified manually. As these filters are not always fixed but depends upon the condition client want to put based on the field the data need to be filtered, how can this structure be implemented in express node api using bookshelf?

or

Is this right approach for REST API to get the filter data or some other way it need to be implemented as per REST API best practices?

Code

routes/contributors.js

var Contributor_Service = require('./../services/contributor-service');

var express = require('express');
var router = express.Router();

    /* GET all the contributors listing. */
    router.get('/', function (req, res, next) {
        Contributor_Service.listAllContributors(req.query, function (err, data) {
            if (err) {
                res.status(500).json({error: true, data: {message: err.message}});
            } else {
                res.json({error: false, data: data.toJSON()});
            }
        });

    });

module.exports = router;

services/contributor-service.js

var Model = require('./../models/Contributor');
var express = require('express');

var listAllContributors = function ( query_params, callback) {

    // for (var x in query_params) {
       // console.log(query_params[x]);
       // console.log(x);
    //}
    Model.Contributors
        .forge()
         .query({where: {status: query_params.status, type: query_params.type}})
        .fetch()
        .then(function (collection) {
            return callback(null, collection);
        })
        .catch(function (err) {
            return callback(err, null);
        });
};

models/Contributor.js

var Bookshelf = require('../../dbconfig').bookshelf;

var Contributor = Bookshelf.Model.extend({
    tableName: 'users'
});
var Contributors = Bookshelf.Collection.extend({
    model: Contributor
});

module.exports = {
    Contributor: Contributor,
    Contributors: Contributors
};

Answer 1

I have used a where object but still not sure if this is right way to write the REST API filter

as there can be many other query parameter for sorting the data, offset and limit, which need to be checked and implemented in controller based on condition and fields passed in query.

services/contributor-service.js

var Model = require('./../models/Contributor');
var express = require('express');

var listAllContributors = function ( query_params, callback) {

var whereObj = {};

    for (var x in query_params) {
        whereObj[x] =  query_params[x];

    Model.Contributors
        .forge()
        .query({where: whereObj})
        .fetch()
        .then(function (collection) {
            return callback(null, collection);
        })
        .catch(function (err) {
            return callback(err, null);
        });
};