Skip to content

danielpquinn/keystone-rest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

keystone-rest

Expose keystone lists via REST api.

Coverage Status Build Status Dependencies

Documentation

http://danielpquinn.github.io/keystone-rest

Usage

var keystone = require('keystone'),
  Types = keystone.Field.Types,
  keystoneRest = require('keystone-rest');

var User = new keystone.List('User');

User.add({
  name: { type: Types.Name, required: true, index: true },
  password: { type: Types.Password, initial: true, required: false, restSelected: false },
  token: { type: String, restEditable: false }
});

User.register();

// Add user api endpoints
keystoneRest.addRoutes(User, 'list show create update delete', {
  list: [listMiddleware],
  show: [showMiddleware],
  create: [createMiddleware],
  update: [updateMiddleware],
  delete: [deleteMiddleware]
}, 'posts');

// Make sure keystone is initialized and started before
// calling registerRoutes
keystone.init(config);
keystone.start();

// Add routes to app
keystoneRest.registerRoutes(keystone.app);

About

Provides a RESTful interface to keystone lists.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •