backframe

Library for building REST API's for expressjs

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
30Oct 9, 2018Jan 23, 2017Minified + gzip package size for backframe in KB

Readme

Backframe Build Status Code Climate Code Coverage

Backframe is a javascript library for declaratively creating REST APIs for Express. Express is a great tool for building lightweight web and application servers, but it leaves almost all of the implementation to the developer. When building REST API's, this usually ends up requiring the developer to write a lot of tedious and repetitive code. Backframe provides simple, declarative tools for building REST APIs.

Read the overview

Installation

Install with npm or yarn:

npm install --save backframe

Usage

Backframe is a great tool for rapidly creating performant REST APIs for your web or mobile application

import express from 'express'
import Backframe from 'backframe'
import Kittens from from 'app/models/kittens'

// initialize backframe
const backframe = Backframe()

// create a resource
const kittens = backframe.resources({
  model: Kittens
})

const app = express()

// mount backframe within express
app.use(backframe.router({
  routes: kittens
}))

app.listen(3000)

Learn more

Author & Credits

Backframe was originally written by Greg Kops and is based upon his work with Think Topography, Funkhaus and The Cornell Cooperative Extension of Tompkins County

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.