@dadi/api

DADI API

 

Overview

DADI API is built on Node.JS and MongoDB. It is a high performance RESTful API layer designed in support of API-first development and the principle of COPE.

You can consider it as the data layer within a platform (including the data model). It is designed to be plugged into a templating layer, a mobile application or to be used with any other data consumer.

Calls to a DADI API can contain your business/domain logic (the part of a platform that encodes the real-world business rules that determine how data is created, displayed, stored and changed). It has full support for searching, filtering, limiting, sorting, offsetting, input validation and data aggregation (through support for MongoDB's aggregation pipeline).

It has built in support for oAuth2, includes full collection-level ACL, can connect to multiple databases out of the box, provides native document versioning at collection level, supports static endpoints, includes automatic indexing, has a caching layer and can be run in a clustered configuration.

DADI API provides a starting point that's further advanced than a framework. It allows you to get a complete data layer up and running in minutes.

It is part of DADI, a suite of components covering the full development stack, built for performance and scale.

Documentation

Documentation is maintained under the docs branch and can be found on the dadi.tech site.

Licence

DADI is a data centric development and delivery stack, built specifically in support of the principles of API first and COPE.

Copyright notice
(C) 2016 DADI+ Limited [e-mail]
All rights reserved

This product is part of DADI.
DADI is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version ("the GPL"). If you wish to use DADI outside the scope of the GPL, please contact us at [e-mail] for details of alternative licence arrangements.

This product may be distributed alongside other components available under different licences (which may not be GPL). See those components themselves, or the documentation accompanying them, to determine what licences are applicable.

DADI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The GNU General Public License (GPL) is available at http://www.gnu.org/copyleft/gpl.html.
A copy can be found in the file GPL distributed with these files.

This copyright notice MUST APPEAR in all copies of the product!

Changelog

1.4.0

Support for Hooks (beforeCreate, afterCreate, beforeUpdate, afterUpdate, beforeDelete, afterDelete).

Provided by @eduardoboucas, many thanks for the hard work on this! Full documentation to be made available soon.

Breaking change: Endpoint Authentication

The default setting is now 'must authenticate'. This means if you have custom endpoints that are currently open and you want them to stay that way, add this block to the JS file:

module.exports.model = {
  settings: {
    authenticate: false
  }
}

Connection module

Previously created connections for every loaded collection, resulting in a new connection pool for each collection. New behaviour is to create one connection per database - if you aren't using enableCollectionDatabases then this means you'll only be making one connection to the database.

Other

• Fix #39. Apply apiVersion filter to query only if it's configured using the useVersionFilter property (ed1c1d8)
• Fix #38. Allow Mixed fields through to the data query, giving back the power to use dot notation in the query (49a0a07)
• Add timestamps to console log statements (018f4f2)
• Modify API host and port requirements. null for host will allow connections on any IPv6 address (if available), otherwise any IPv4 address. If port is 0 a random port will be assigned (3d5e0e0)
• Add response to OPTIONS requests, thanks @eduardoboucas (969d808)
• Add authentication on a per-HTTP method basis, thanks @eduardoboucas (a00b72c)
• Use HTTP PUT for updates (also backwards-compatible with POST) (865e7f6)
• Add WWW-Authenticate header to when sending HTTP 401 responses (4708020)
• Add config settings for log file rotation (4e7e81d)
• Add logging level to limit log records (e282e62)