diff --git a/README.md b/README.md index 5dd2c64..cd225fe 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,26 @@ Example: Read registered resources: - - `/cities`: List registered cities. - - `/countries`: List registered countries. - - `/product-categories`: List registered product-categories. - - `/states`: List registered states. + - `GET /countries`: List registered countries. + - `GET /cities`: List registered cities. + - `GET /meta-data`: List registered meta-data. + - `GET /meta-groups`: List registered meta-data. + - `GET /product-categories`: List registered product-categories. + - `GET /states`: List registered states. All these endpoints support the following parameters: - `/` : List registered resources with pagination. - `/:id` : Read specific resource identified by Id. - `/find?regex=xxx` : List resources that matches with regex (support pagination). + +## Private Endpoints + +The following list of endpoints requires a JWT. + +## Test Endpoint + +A private endpoint to test the JWT and the api response. + + - `POST /apitest`: Return whatever is sent on the body, queries and parameters. + - `GET /version`: Return the API version. \ No newline at end of file diff --git a/sections/meta-data/routes.js b/sections/meta-data/routes.js new file mode 100644 index 0000000..c9862ab --- /dev/null +++ b/sections/meta-data/routes.js @@ -0,0 +1,9 @@ +'use strict'; +const router = require('express').Router(); +const services= require('./services.js'); + +router.get('/', services.getMetaDataList); +router.get('/find', services.findMetaDataList); +router.get('/:id', services.getMetaData); + +module.exports = router; diff --git a/sections/meta-data/services.js b/sections/meta-data/services.js new file mode 100644 index 0000000..10702ef --- /dev/null +++ b/sections/meta-data/services.js @@ -0,0 +1,28 @@ +"use strict"; +const { ROOT_PATH, LIB_PATH, MODELS_PATH, HANDLERS_PATH } = process.env; +const { getPagination , queryPage } = require( `${ROOT_PATH}/${LIB_PATH}/Misc.js` ); +const Model = require( `${ROOT_PATH}/${MODELS_PATH}/meta-data.model.js` ); + +const getMetaDataList = async(req, res) => { + const { page , elements } = getPagination( req.query ); + const retVal = await queryPage( page , elements, Model ); + res.send( retVal ); +}; + +const findMetaDataList = async(req, res) => { + let filter=null; + if( req.query.regex ){ + const re = new RegExp( req.query.regex ); + filter = { "meta_value" : { $regex: re, $options: 'i' }}; + } + const { page , elements } = getPagination( req.query ); + const retVal = await queryPage( page, elements, Model, filter ); + res.send( retVal ); +}; + +const getMetaData = async(req, res) => { + const retVal = await Model.findById( req.params.id ); + res.send( retVal ); +}; + +module.exports = { getMetaDataList, findMetaDataList, getMetaData }; diff --git a/sections/meta-groups/routes.js b/sections/meta-groups/routes.js new file mode 100644 index 0000000..f2653dd --- /dev/null +++ b/sections/meta-groups/routes.js @@ -0,0 +1,9 @@ +'use strict'; +const router = require('express').Router(); +const services= require('./services.js'); + +router.get('/', services.getMetaGroupsList); +router.get('/find', services.findMetaGroupsList); +router.get('/:id', services.getMetaGroups); + +module.exports = router; diff --git a/sections/meta-groups/services.js b/sections/meta-groups/services.js new file mode 100644 index 0000000..d883258 --- /dev/null +++ b/sections/meta-groups/services.js @@ -0,0 +1,28 @@ +"use strict"; +const { ROOT_PATH, LIB_PATH, MODELS_PATH, HANDLERS_PATH } = process.env; +const { getPagination , queryPage } = require( `${ROOT_PATH}/${LIB_PATH}/Misc.js` ); +const Model = require( `${ROOT_PATH}/${MODELS_PATH}/meta-groups.model.js` ); + +const getMetaGroupsList = async(req, res) => { + const { page , elements } = getPagination( req.query ); + const retVal = await queryPage( page , elements, Model ); + res.send( retVal ); +}; + +const findMetaGroupsList = async(req, res) => { + let filter=null; + if( req.query.regex ){ + const re = new RegExp( req.query.regex ); + filter = { "group_label" : { $regex: re, $options: 'i' }}; + } + const { page , elements } = getPagination( req.query ); + const retVal = await queryPage( page, elements, Model, filter ); + res.send( retVal ); +}; + +const getMetaGroups = async(req, res) => { + const retVal = await Model.findById( req.params.id ); + res.send( retVal ); +}; + +module.exports = { getMetaGroupsList, findMetaGroupsList, getMetaGroups }; diff --git a/sections/sections.js b/sections/sections.js index f36f526..346f681 100644 --- a/sections/sections.js +++ b/sections/sections.js @@ -11,12 +11,16 @@ const countries = require('./countries/routes.js'); const cities = require('./cities/routes.js'); const productCategories = require('./product-categories/routes.js'); const states = require('./states/routes.js'); +const metaData = require('./meta-data/routes.js'); +const metaGroups = require('./meta-groups/routes.js'); -router.use("/test", test); router.use('/countries', countries); router.use('/cities', cities); +router.use('/meta-data', metaData); +router.use('/meta-groups', metaGroups); router.use('/product-categories', productCategories); router.use('/states', states); +router.use("/test", test); router.use( jwtValidator.middleware ); @@ -24,8 +28,6 @@ router.use("/users", users); router.use('/orders', test); router.use('/companies', test); -router.use('/metaGroups', test); -router.use('/metaData', test); router.use('/loads', test); router.use('/vehicles', test); router.use('/mailer', test); diff --git a/sections/test/routes.js b/sections/test/routes.js index efd3320..5090319 100644 --- a/sections/test/routes.js +++ b/sections/test/routes.js @@ -2,7 +2,7 @@ const router = require('express').Router(); const services= require('./services.js'); -router.get('/apitest', services.postTest); +router.post('/apitest', services.postTest); router.get('/version', services.getVersion); module.exports = router;