npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongoose-restapi-ui

v1.8.0

Published

Rest api library for your mongoose apps, with react ui: mongoose-restapi-ui-component react library

Downloads

54

Readme

Mongoose API Generator with UI embedded

npm version Build Status NPM Status codecov.io Donate

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 or desc 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:

import { ApiRouter } from 'mongoose-restapi-ui'
const customer = model('Customer', new Schema({
    name: { type: String, required: true },
    comment: { type: String }
}))
router.setModel('/customer', customer)
app.use('/', router)

In order to use on a different path, mark it on our ApiRouter

...
router.setGlobalRoute('/api/config')
...
router.setModel(...
router.setModel(...
app.use('/api/config', router)

Publish UI:

app.get('/api/ui', router.publishUiTree())

(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:

import * as express from 'express'
import { ApiRouter } from 'mongoose-restapi-ui'
import { model, Schema, connect } from 'mongoose'

connect('mongodb://localhost:27017/dummyDatabase')
const customer = model('Customer', new Schema({
    name: { type: String, required: true },
    comment: { type: String }
}))
const app = express()
const router = ApiRouter()
router.use((req, res, next)=>{
    req.user = // your mongoose user document....
    next()
})
router.setModel('/customer', customer)
router.setConnection(mongoose) // or object returned from mongoose.connect
app.use('/', router)
app.listen(3000)

Javascript:

const express = require('express')
const { model, Schema, connect } = require('mongoose')
const { ApiRouter } = require('mongoose-restapi-ui')

connect('mongodb://localhost:27017/dummyDatabase')

const customer = model('Customer', new Schema({
    name: { type: String, required: true },
    comment: { type: String }
}))

const app = express()
const router = ApiRouter()
router.use((req, res, next)=>{
    req.user = // your mongoose user document....
    next()
})
router.setModel('/customer', customer)
router.setConnection(mongoose) // or object returned from mongoose.connect
app.use('/', router)
app.listen(3000)

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)

import ApiRouter from 'mongoose-restapi-ui'
const router = ApiRouter()

If your database is MongoDB 4.X, this library can use his new API ($any can filter numbers, _id, dates... as a contains)

import ApiRouter from 'mongoose-restapi-ui'
const router = ApiRouter({isMongo4: true})

This object has the same properties as router, with other ones:

Next features

  • API rest self documented
  • Permissions and roles inheritance