Simple API core for your projects

Useful links

Dependencies

Structure

📙
 ├── ⚙️ controllers Request controllers
 ├── 🗃️ models Models for working with DB
 │ └── 📁 <driver> Database driver name (Optional)
 │ └── 📜 <model> Model name (js or json)
 ├── ️📃 config.json Configuration file
 └── ⏱ startup.js Script, that was started before starting API server

Installation (manually)

config.json

{
 "port": "$env", // Equals value of process.env.PORT
 "db": {
 "mongo": {
 "host": "localhost",
 "name": "test-db"
 }
 },
 "plugins": ["dc-api-mongo"],
 "session": {
 "secret": "super secret string",
 "store": "mongo"
 },
 "ssl": {
 "cert": "/etc/letsencrypt/live/awesome.site/cert.pem",
 "key": "/etc/letsencrypt/live/awesome.site/privkey.pem"
 },
 "dev": {
 "port": 8081,
 "db": {
 "mongo": { "name": "test-dev-db" }
 }
 }
}

MongoDB (recommended)

// JS
const db = require('dc-api-mongo').connect();
// TS
import db from 'dc-api-mongo/mongo';
async function main() {
 const result = await db.Model.findOne();
 console.log(result);
}
main();

MySQL

const db = require('dc-api-mysql').connect();
async function main() {
 const result = await db.Model.findOne();
 console.log(result);
}
main();

Plugins

{
 // ...
 "plugins": ["dc-api-mongo"]
}

Sessions

Functions

Example

module.exports = class Controller {
 async test () {
 this.session.name = 'test';
 await this.session.save();
 this.send('saved');
 }
}

Request hooks

onLoad

Example

module.exports = class Test {
 onLoad () {
 if (!this.session.user) return false;
 }
}

Data Validation

Main check function

module.exports = class Test {
 async createUser () {
 const result = this.validator.check(this.data, [
 {
 name: 'email',
 type: 'string',
 use: this.validator.email
 },
 {
 name: 'password',
 type: 'string',
 use: this.validator.password
 },
 {
 name: 'age',
 type: 'number',
 min: 18,
 max: 100
 }
 ]);
 if (!result.success) {
 this.send({ errors: result.errors }, 400);
 return;
 }
 const validatedData = result.filtered;
 
 this.send(validatedData);
 }
}

Field Schema

Built-in Validators

validator.email(email)

{
 name: 'email',
 type: 'string',
 use: this.validator.email
}

validator.phone(phone)

{
 name: 'phone',
 type: 'string',
 use: this.validator.phone
}

validator.password(password)

{
 name: 'password',
 type: 'string',
 use: this.validator.password
}

validator.ObjectId(value)

{
 name: 'userId',
 type: 'string',
 use: this.validator.ObjectId
}

validator.hostname(hostname)

{
 name: 'domain',
 type: 'string',
 use: this.validator.hostname
}

validator.url(url)

{
 name: 'website',
 type: 'string',
 use: this.validator.url
}

validator.inArray(array)

{
 name: 'status',
 type: 'string',
 use: this.validator.inArray(['active', 'inactive', 'pending'])
}

Usage Examples

Object Validation

module.exports = class Test {
 async createProfile () {
 const result = this.validator.check(this.data, [
 {
 name: 'user',
 type: 'object',
 fields: [
 { name: 'name', type: 'string', min: 2, max: 50 },
 { name: 'email', type: 'string', use: this.validator.email }
 ]
 }
 ]);
 if (!result.success) {
 this.send({ errors: result.errors }, 400);
 return;
 }
 this.send(result.filtered);
 }
}

Array Validation

module.exports = class Test {
 async createItems () {
 const result = this.validator.check(this.data, [
 {
 name: 'items',
 type: 'array',
 min: 1,
 max: 10,
 of: {
 type: 'string',
 min: 3
 }
 }
 ]);
 if (!result.success) {
 this.send({ errors: result.errors }, 400);
 return;
 }
 this.send(result.filtered);
 }
}

Enum Validation

module.exports = class Test {
 async updateStatus () {
 const result = this.validator.check(this.data, [
 {
 name: 'status',
 type: 'string',
 enum: ['pending', 'approved', 'rejected']
 }
 ]);
 if (!result.success) {
 this.send({ errors: result.errors }, 400);
 return;
 }
 this.send(result.filtered);
 }
}

Working with config.json

Require

// JS
const config = require('dc-api-core/config');
// TS
import config from 'dc-api-core/config';

config.<your_param>

Example

const config = require('dc-api-core/config');
module.exports = class Test {
 index() {
 this.send(config.myParam);
 }
}

Routing

// startup.js
const Router = require('dc-api-core/router');
Router.register('/testing/files/${id}/${file}.jpg', 'Test.getFile');

// controllers/Test.js
class Test {
 async getFile () {
 this.send(this.params);
 // Will send { "id": "some-id", "file": "secret_file" }
 }
}
module.exports = Test;

My TODOs