@janiscommerce/api-get

API Get

A package to handle JANIS Get APIs

Installation

npm install @janiscommerce/api-get

Usage

'use strict';

const { ApiGet } = require('@janiscommerce/api-get');

class MyApiGet extends ApiGet {

	get fieldsToSelect() {
		return [
			'id',
			'name',
			'status'
		];
	}

	async format(record) {
		return {
			...record,
			oneMoreField: true
		};
	}

	_parseFilters({ id, ...otherFilters }) {
		return {
			...otherFilters,
			id: Number(id)
		};
	}

	/**
	 * Validates the record getted from DB before format.
	 * @param {Object} The record in DB
	 **/
	async postGetValidate({ name }) {

		if(name === FORBIDDEN_NAME) {
			this.setCode(403);
			throw new Error('Forbidden name');
		}
	}

}

module.exports = MyApiGet;

All methods are optional

Get APIs with parents

If you have for example, a get API for a sub-entity of one specific record, the parent will be automatically be added as a filter.

For example, the following endpoint: /api/parent-entity/1/sub-entity/2, will be a get of the sub-entity, and parentEntity: '1' will be set as a filter.

Changelog

[4.0.0] - 2020-08-27

Added

• GitHub Actions for build, coverage and publish
• Added Type-definitions

Changed

• Updated @janiscommerce/api to 6.x.x