orion-api

Orion API

Orion is an extension of Express which allows you to build a fully functional REST API in just a few steps! It sets up all the CRUD data endpoints, file uploads, authentication endpoints, and error handling for you. All you need to do is just create a configuration and instantiate the application!

Supported components

The library allows you to use the following services based on your preferences:

• Database: SQL Server / MySQL
• File storage: Azure Blob Storage / Amazon S3 / Local Server
• Authentication: Facebook token / Orion JSON Web Token (JWT)
• Monitoring: Azure Application Insights

Installation

$ npm install --save orion-api

Example usage

config.js

module.exports =
{
    database:
    {
        engine: "mssql",
        connectionString: _DATABASE_CONNECTION_STRING_
    },
    entities:
    {
        "blogpost":
        {
            "fields":
            {
                "title": { type: "string", isEditable: true, createReq: 2, foreignKey: null },
                "content": { type: "richtext", isEditable: true, createReq: 2, foreignKey: null }
            },
            "allowedRoles":
            {
                "read": ["guest"],
                "create": ["guest"],
                "update": ["guest"],
                "delete": ["guest"]
            }
        }
    }
};

server.js

var orion = require('orion-api');
var config = require('./config');
var app = new orion(config);
app.setupApiEndpoints();
app.start();

Documentation

• Home
• Create Your First Orion Application
• API Endpoints
• Configuration Options
• Sample Configuration
• Authentication
• User Roles
• Condition Syntax
• API Reference

Links

Contributing

License