baucis

baucis v1.1

Build scalable REST APIs using the open source tools and standards you and your team already know — Mongoose, Express, and Node.js streams. Baucis takes the boilerplate out of building and maintaining scalable HATEOAS/Level 3 REST APIs.

Baucis has tens of thousands of users and is used in production by startups, departments, and Fortune 500 companies, and at hackathons and conferences worldwide. MongoDB, Inc. awarded baucis first place in their 2014 Open Source Hack Contest.

Baucis is easy for beginners, easy to scale, yet flexible enough in the long term to be extended to solve complex use cases.

Who's using Baucis?

If you like baucis please consider adding bounties to issues in the issue tracker or contributing via GitTip.

Features

• Automatically build controllers from your Mongoose schemata, then easily configure them.
• Built on Express 4 so adding custom middleware is a snap. Compatible with existing Express middleware.
• Fully takes advantage of Node.js streaming to nimbly process large datasets.
• Implements the HTTP specification according to the specifications (RFC 7231, etc.)
• Widely compatible with a variety of front end frameworks.
• Perform rich queries of the API using an expressive JSON syntax via query string.
• Supports geolocation and full text search.
• Version your API using semver.
• Automatically generate interactive Swagger documentation for the API.
• Highly customizable, simple interface. Can be extended with plugins (decorators).
• Compatible with MongoDB 2.x and 3.x
• Over 140 Mocha.js tests in addition to Express' and Mongoose's.

Getting Started

To install:

npm install --save baucis

An example of creating a REST API from a couple Mongoose schemata.

// Create a mongoose schema.
var Vegetable = new mongoose.Schema({ name: String });
// Register new models with mongoose.
mongoose.model('vegetable', Vegetable);
// Create a simple controller.  By default these HTTP methods
// are activated: HEAD, GET, POST, PUT, DELETE
baucis.rest('vegetable');
// Create the app and listen for API requests
var app = express();
app.use('/api', baucis());
app.listen(8012);

That's it! Now you have an RFC-compliant, flexible, and semantically rich API dealing with vegetables. You could access it with URLs like http://localhost:8012/api/vegetables. CRUD is supported using GET, PUT, POST, and DELETE.

Examples

• Example REST API server built with Node and Baucis
• Examples with Backbone.js
• Examples with AngularJS
• Examples with Restangular
• Examples with jQuery
• mongoose-administration-example

Documentation

Check out the Wiki for documentation and more in-depth information about baucis. Check the change log for info on recently implemented features.

Coming Soon

• Real time browser/client subscription with EventSource (server sent events)
• Web hooks
• To see everything that's in store visit the GitHub milestones page for this repo.

Contact

• Twitter @wprl
• LinkedIn
• Email [e-mail]

© 2012-2015 Kun.io App Studio LLC