Package Exports

api-core

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (api-core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

API Core

Features:

Dynamic model-based API routes
Extensible API queries with pre- and post-query steps
- Transformations (via api-core-mapper or your own library)
- Authentication, ACL (via node-acl, passport, etc.)
Multi level API routes (eg. /schools/42/students/3/courses)
Multi channel APIs (eg. consuming HTTP and socket.io via api-provider packages)
Multi database APIs (different database for every route, if you need)

UNDER DEVELOPMENT

First beta and documentation coming soon...

Basics

Installation

npm install api-core

API Edges

In API Core every API is built from edges. An edge defines operations and relations of a Data Model.

Every edge provides the following operations:

List entries (eg. GET /students)
Get an entry (eg. GET /students/3)
Create an entry (eg. POST /students)
Replace/Update an entry (eg. PUT /students/3)
Edit an entry (eg. PATCH /students/3)
Remove an entry (eg. DELETE /students/3)
Access to operations of one-to-one relations (eg. GET /students/3/class)
Access to operations of one-to-many relations (eg. GET /schools/42/students/3/courses)
Access to custom operations (coming soon)

Every operation provides standard features like filtering, sorting, population and pagination.

Also every operation is available via all enabled channels.

So while you can list students via a HTTP request, you also can do the same via a socket.io message or any custom channel defined by you.

API Providers

You can use API Providers to make your API consumable via different channels.

We have (or working on) providers for the following channels:

HTTP
- Express: api-provider-express
- Koa: api-provider-koa
- Restify: api-provder-restify
- Ellipse: api-provider-ellipse
Socket
- socket.io: api-provider-socket.io

Also you can implement your own API provider. For more information take a look at api-provider.

Data Models

Every API requires a set of data models. As with API Providers, you have a bunch of options when choosing your library for creating the models.

We have (or working on) data model libraries for the following frameworks:

MongoDB: api-model-mongoose
MySQL
...

Also you can implement your own API model library.

SNEAK PEAK

We have two working samples in the following repository, one with a local in-memory model and one with a Mongoose model.

Working Demo: api-demo

A complete API with 5 models and relations in 77 lines:

import {ApiEdgeError, OneToOneRelation, OneToManyRelation, ApiEdgeQueryResponse, Api} from "api-core";
import {MongooseModelFactory} from "api-model-mongoose";
import {EllipseApiRouter} from "api-provider-ellipse";
import * as mongoose from "mongoose";

const Ellipse = require('ellipse'),
      app = new Ellipse;

mongoose.Promise = global.Promise;
mongoose.connect("mongodb://localhost/api-demo");

const studentEdge =
          MongooseModelFactory.createModel("student", "students", {
              id: String,
              firstName: String,
              lastName: String,
              email: String,
              phone: String,
              schoolId: mongoose.Schema.Types.ObjectId,
              classId: mongoose.Schema.Types.ObjectId
          }),
      classEdge =
          MongooseModelFactory.createModel("class", "classes", {
              id: String,
              name: String,
              semester: String,
              room: String,
              schoolId: mongoose.Schema.Types.ObjectId
          }),
      courseEdge =
          MongooseModelFactory.createModel("course", "courses", {
              id: String,
              name: String,
              classId: mongoose.Schema.Types.ObjectId,
              courseTypeId: mongoose.Schema.Types.ObjectId
          }),
      courseTypeEdge =
          MongooseModelFactory.createModel("courseType", "courseTypes", {
              id: String,
              name: String
          }),
      schoolEdge =
          MongooseModelFactory.createModel("school", "schools", {
              id: String,
              name: String,
              address: String,
              phone: String
          });

const api10
    = new Api('1.0')
        .edge(studentEdge);

const api11
    = new Api('1.1')
        .edge(studentEdge)
        .edge(classEdge)
        .edge(courseEdge)
        .edge(courseTypeEdge)
        .edge(schoolEdge)
        .relation(new OneToOneRelation(courseEdge, courseTypeEdge))
        .relation(new OneToManyRelation(courseTypeEdge, courseEdge))
        .relation(new OneToManyRelation(studentEdge, courseEdge))
        .relation(new OneToOneRelation(studentEdge, classEdge))
        .relation(new OneToOneRelation(studentEdge, schoolEdge))
        .relation(new OneToOneRelation(classEdge, schoolEdge))
        .relation(new OneToOneRelation(courseEdge, classEdge))
        .relation(new OneToManyRelation(classEdge, studentEdge))
        .relation(new OneToManyRelation(classEdge, courseEdge))
        .relation(new OneToManyRelation(schoolEdge, studentEdge))
        .relation(new OneToManyRelation(schoolEdge, classEdge));

app.use(require('body-parser').json());

const router = new EllipseApiRouter(api11, api10);
router.apply(app);

app.listen(8080);