feat: Adding meta-groups and meta-data endpoints
This commit is contained in:
21
README.md
21
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.
|
||||
9
sections/meta-data/routes.js
Normal file
9
sections/meta-data/routes.js
Normal file
@@ -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;
|
||||
28
sections/meta-data/services.js
Normal file
28
sections/meta-data/services.js
Normal file
@@ -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 };
|
||||
9
sections/meta-groups/routes.js
Normal file
9
sections/meta-groups/routes.js
Normal file
@@ -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;
|
||||
28
sections/meta-groups/services.js
Normal file
28
sections/meta-groups/services.js
Normal file
@@ -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 };
|
||||
@@ -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);
|
||||
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user