Topics

• Introduction
• Installation
• Getting started
• API documentation

Introduction

REST API generator for objection.js models.

Installation

npm install objection objection-rest

Getting started

var objection = require('objection');
var ObjectionRest = require('objection-rest');
var Person = require('./models/Person');
var Movie = require('./models/Movie');

ObjectionRest(objection)
	.routePrefix('/api')
	.addModel(Person, function(findQuery) {
		// findQuery.registerFilter(...) see objection-find
	})
	.addModel(Movie)
	.generate(app);

API documentation

See objection-find documentation for the findQuery API.