Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dadi/api

A high-performance RESTful API layer designed in support of API-first development and COPE. Connects your content to the world
https://github.com/dadi/api

api cms dadi dadi-api headless

Last synced: 1 day ago
JSON representation

A high-performance RESTful API layer designed in support of API-first development and COPE. Connects your content to the world

Host: GitHub
URL: https://github.com/dadi/api
Owner: dadi
License: other
Created: 2015-12-18T13:25:14.000Z (about 9 years ago)
Default Branch: develop
Last Pushed: 2024-08-07T13:09:14.000Z (5 months ago)
Last Synced: 2025-01-02T10:06:55.862Z (9 days ago)
Topics: api, cms, dadi, dadi-api, headless
Language: JavaScript
Homepage: https://dadi.cloud/en/api/
Size: 11.3 MB
Stars: 180
Watchers: 28
Forks: 29
Open Issues: 40
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS

Awesome Lists containing this project

README

DADI API

[![npm (scoped)](https://img.shields.io/npm/v/@dadi/api.svg?maxAge=10800&style=flat-square)](https://www.npmjs.com/package/@dadi/api)
[![coverage](https://img.shields.io/badge/coverage-89%25-yellow.svg?style=flat)](https://github.com/dadi/api)
[![Build Status](https://travis-ci.org/dadi/api.svg?branch=master)](https://travis-ci.org/dadi/api)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

## DADI API

- [Overview](#overview)
- [Requirements](#requirements)
- [Your First API Project](#your-first-api-project)
- [Links](#links)

## Overview

DADI API is built on Node.JS. It is a high performance RESTful API layer designed in support of API-first development and the principle of COPE. It can use virtually any database engine, such as [MongoDB](https://github.com/dadi/api-mongodb), [CouchDB](https://github.com/dadi/api-couchdb), [RethinkDB](https://github.com/dadi/api-rethinkdb) or simply a [JSON filestore](https://github.com/dadi/api-filestore).

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 (such as [DADI Web](https://dadi.cloud/en/web)), 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.

## Requirements

- **[Node.js](https://www.nodejs.org/)** (supported versions: 6.11.x, 8.9.x)
- A [data connector module](https://www.npmjs.com/search?q=keywords:dadi-api-connector)

## Your first API project

### Install API

The quickest way to get started with _API_ is to use [DADI CLI](https://github.com/dadi/cli). See [Creating an API](https://docs.dadi.cloud/api#creating-an-api) for full installation details.

### Configuration

API starts with some sensible defaults, so it's not necessary to understand all the configuration options available when first running the application.

Configuration is handled using JSON files specific to the application environment. For example in the production environment a file named `config.production.json` will be used. Configuration files must be placed in a `config` folder in your application root, for example `config/config.production.json`. The default start up environment is `development`, using the configuration file at `config/config.development.json`.

The bare minimum required for running the API is a `server` block. With only a `server` block, default values are used for all other properties.

**Sample configuration**

```json
{
"server": {
"host": "127.0.0.1",
"port": 3000
}
}
```

### Start the server

API can be started from the command line simply by issuing the following command:

```bash
$ npm start
```

#### Test the connection

With the default configuration, our API server is available at http://localhost:3000. If you've modified the configuration file's `server` block, your API will be available at the address and port you've chosen. Use cURL to check the server is running, if the connection can be made you will receive the following "Unauthorised" message.

```bash
$ curl http://localhost:3000
```

```json
{"statusCode": 401}
```

#### Check the response headers

```bash
$ curl -I http://localhost:3000
```

```json
HTTP/1.1 401 Unauthorized
content-type: application/json
content-length: 18
Date: Thu, 20 Apr 2017 23:42:25 GMT
Connection: keep-alive
```

### Authentication

The HTTP 401 response received in the previous step shows that the server is running. To start using the REST endpoints you'll need a user account so you can obtain access tokens for interacting with the API.

User accounts provide an authentication layer for API. Each user account has a _**clientId**_ and a _**secret**_. These are used to obtain access tokens for interacting with the API. See the [Authentication](https://docs.dadi.cloud/api#authentication) section of the API documentation for full details.

#### Creating the first user

[CLI](https://github.com/dadi/api) contains an interactive "Client Record Generator" to help you create user accounts. Run the following command in the directory where you installed _API_:

```bash
cd my-new-api
dadi api clients:add
```

If you need to create user accounts in other environments (for example following a deployment to a live server), add the environment to the following command:

```bash
$ NODE_ENV=production npm explore @dadi/api -- npm run create-client
```

### Run API as a service

To run your API application in the background as a service, install Forever and Forever Service:

```bash
$ npm install forever forever-service -g

$ sudo forever-service install -s index.js -e "NODE_ENV=production" api --start
```

You can now interact with the `api` service using the following commands:

```bash
$ [sudo] service api start
$ [sudo] service api stop
$ [sudo] service api status
$ [sudo] service api restart
```

> Note: the environment variable `NODE_ENV=production` must be set to the required configuration version matching the configuration files available in the `config` directory.

## Tests

To run the tests after cloning the repository, run the following command:

```
$ npm test
```

> NOTE: API installs version 4.0.1 of Mocha and uses this when calling `npm test`. If you have Mocha installed globally and want to simply run `mocha`, if using version 4 or above, add `--exit` to the command so it becomes `mocha --exit`

## Links

- [API Documentation](https://docs.dadi.cloud/api/)

## Contributors

DADI API is based on an original idea by Joseph Denne. It is developed and maintained by the engineering team at DADI ([https://dadi.cloud](https://dadi.cloud))

- Adam K Dean
- Arthur Mingard
- David Longworth

- Eduardo Bouças
- Francesco Iannuzzelli
- James Lambie
- Joe Wagner
- Joseph Denne
- Kevin Sowers
- Robert Stanford
- Viktor Fero

## Licence

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

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 3 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 [email protected] 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/licenses/gpl-3.0.en.html.

A copy can be found in the file GPL.md distributed with
these files.

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