API action

​

Overview

API action — is HTTP handler that perform database updates and other logic required by the business logic. Actions should reside in the /actions folder within resource. Usually action is a single file that has meaningful name, e.x. list, get-by-id, update-email.

If action has a lot of logic and require multiple files it needs to be placed into the folder with name of the action and action need to exposed using module pattern (index.ts file).

Direct database updates of the current resource entity are allowed within action.

​

Examples

import Router from '@koa/router';

import { AppKoaContext } from 'types';

import { validateMiddleware } from 'middlewares';

type GetCompanies = {
  userId: string;
};

async function handler(ctx: AppKoaContext<GetCompanies>) {
  const { userId } = ctx.validatedData; // validatedData is returned by API validator

  ctx.body = {}; // action result sent to the client
}

export default (router: Router) => {
  // see Rest API validator
  router.get('/companies', validateMiddleware(schema), handler);
};