zircaloy-api

Zircaloy API Handler

This package is an ultra light weight RESTful api handler for node.

It belongs to the Zircaloy light weight framework.

Installation

Use the package manager npm to install.

npm i zircaloy-api

Features

Current

• Easy to use
• RESTful API
• Schema based
• Out of the box validation
• Reliable and scalabe directory structure based

Future:

• Out of the box private and internal APIs

Usage

Directory structure example

- item
	- index.js
	- API
		- get.js		----------> GET API
		- post.js 		----------> POST API
		- schema.js 		----------> VALIDATION SCHEMA
		- index.js 		----------> EXPORTER

Instanciate

const { apiHandler, httpCodes } = require('modules/api');
const apiSettings = require('config/api-settings');

const APIHandler = apiHandler(apiSettings);

const API = await APIHandler.getApi(baseUrl, method, query, body, headers);

API
	.once('finished', apiResponse => {
		// Do something
	})
	.once('error', (apiError) => {
		// Do something
	})
	.process();

Settings Schema Example

module.exports = {
	apis: [
		{
			name: 'item',
			url: '/api/item',
			path: 'path/to/api/folder/item/',
			type: 'public',
		},
		{
			name: 'file',
			url: '/api/file',
			path: 'path/to/api/folder/file/',
			type: 'public',
		},
	],
};

Exporter Example

exports.get = require('./get');
exports.post = require('./post');

Validation Schema Example

const Joi = require('joi');
module.exports = {
	GET: {
		query: {
			id: Joi.string().length(24).required(),
		},
	},
	POST: {
		headers: {
			'X-Custom-Header': Joi.string().required(),
		},
		body: {
			name: Joi.string().required(),
			keywords: Joi.array().items(Joi.string()),
		},
	},
};

API GET Example

const { API, APIResponse, APIError, httpCodes } = require('modules/api');

class GET extends API {
	async process() {
		if (!await this.isValidRequest()) return;

		try	{
			// Your code here
			const { id } = this.query; // Inheritance from API

			const response = new APIResponse(httpCodes.OK, { id });
			this.sendResponse(response);
		} catch (err) {
			this.sendError(new APIError('We are experiencing some issues. Try again later', httpCodes.INTERNAL_SERVER_ERROR));
		}
	}
}

module.exports = GET;

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT License

Copyright (c) 2019 Gonzalo Spina

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.