Giter VIP home page Giter VIP logo

baucis's Introduction

baucis

Codeship

Gitter

NPM

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?

Hivepod.io Kun.io App Studio LLC Pixel Press

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

It's easy to create an API from a Mongoose model:

// 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

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

Contact

ยฉ 2012-2015 Kun.io App Studio LLC

baucis's People

Contributors

alonbardavid avatar alpacaaa avatar andyzickler avatar fanfuzion avatar felipefdl avatar gitter-badger avatar kbaylosis avatar lcalvy avatar lukaszfiszer avatar neverfox avatar pappacena avatar pirhoo avatar pjmolina avatar qraynaud avatar stemey avatar timbur avatar toolito avatar william-riley-land avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.