Mongoose API Generator with UI embedded
This package provides a Rest API for your mongoose models, with the following endpoints:
GET /model
(with querystring for each path, with additional parameters:$any
: any colum,$sortBy
: sort by a column,$sort
:asc
ordesc
and$page
: number page)GET /model/:_id
GET /model/:name
POST /model
PUT /model/:_id
PUT /model/:name
DELETE /model/:_id
DELETE /model/:name
Usage
Use our router extended from express with our custom methods:
const customer = routerapp
In order to use on a different path, mark it on our ApiRouter
...router...router
Publish UI:
app
(Note that publishUI method don't need the global path, can be published on other site and accepts an optional parameter express.Router that will be switched if there are provided. If not are provided there are all models and UI on the same router.)
(NEW) Use permissions and roles
The library needs to pass your mongoose connection, and a middleware in order to get the user. Here an example:
Typescript:
const customer = const app = const router = routerrouterrouter // or object returned from mongoose.connectappapp
Javascript:
const express = const model Schema connect = const ApiRouter = const customer = const app = const router = routerrouterrouter // or object returned from mongoose.connectappapp
UI integration
Use react component mongoose-restapi-ui-component.
API
Default object is an extended express Router, please initialize as express Router. (Default mongodb api is v3.x)
const router =
If your database is MongoDB 4.X, this library can use his new API ($any can filter numbers, _id, dates... as a contains)
const router =
This object has the same properties as router, with other ones:
Name | Type | Description |
---|---|---|
setGlobalRoute(path) |
path : string |
witch for nexts models that their api starts in path path . |
setModel(route, model [, options]) |
route : stringmodel : mongoose.Modeloptions : ServeOptions returns EventEmitter |
Set model model on path route from the router. Generates GET, POST, PUT, PATCH and DELETE methods.
Returns an EventEmitter that emits the following events:
|
ServeOptions |
{name : stringgetFilterByPermissions : FilterByPermissionshasAddPermission : RequestPermissionhasEditPermission : RequestPermissionhasUpdatePermission : RequestPermissionhasDeletePermission : RequestPermission} |
Switch path name as the name label for UI purpose as complex objects. |
FilterByPermissions(req, callback) |
req: express.Request callback: FilterByPermissionsCallback |
Function in order to get a pre-filter query (query), for a custom permissions setup. |
FilterByPermissionsCallback(err, query) |
err: Error query: Object |
Callback called in order to get a pre-filter query (query), for a custom permissions setup. |
IUser | must be extend: { roles: ObjectId } & mongoose.Document | User used in order to set permissions and roles. |
RequestPermission(user, doc, callback) |
user: IUser doc: mongoose.Document callback: RequestPermissionCallback |
called on interaction with an endpoint rest (post, put, patch or delete) |
RequestPermissionCallback(error, hasPermission, reason?) |
error : ErrorhasPermission : Booleanreason ?: string |
Will be called in order to custom permissions.
Will be called second callback parameter with true or false as result of permission check.
If there are provided the third parameter of callback and false are provided as result, will be sended it as custom statusText with status 403. |
Next features
- API rest self documented
- Permissions and roles inheritance