Barabara

Automatic express-router from generic controllers

Barabara will automatically create one or more Express router for you reading the content of your controller folder(s).

Installation

npm install barabara

Usage

Import in your project

// require Barabara
const { Barabara } = require('barabara');
// import Barabara
import { Barabara } from 'barabara';

Create an instance

const express = require('express');

const barabara = new Barabara(
  // Router class
  express.Router,
  // Mapping between controller actions & http verbs
  {
    exists: 'head',
    read: 'get',
    create: 'post',
    update: 'put',
    partial: 'patch',
    destroy: 'delete'
  }
);

With this mapping Barabara will look up for corresponding controller actions and create the following routes:

• HEAD /my-controller will call myController.exists(params, meta)
• HEAD /my-controller/:id will call myController.exists(params, meta)
• GET /my-controller will call myController.read(params, meta)
• GET /my-controller/:id will call myController.read(params, meta)
• POST /my-controller will call myController.create(params, meta)
• PUT /my-controller/:id will call myController.update(params, meta)
• PATCH /my-controller/:id will call myController.partial(params, meta)
• DELETE /my-controller/:id will call myController.destroy(params, meta)

Create routers

  // Here we add req.user in meta parameter of controller actions methods
  const authRouter = barabara.createRouter(path.join(__dirname, 'controllers/auth'), [ 'user' ]);
  const v1ApiRouter = barabara.createRouter(path.join(__dirname, 'controllers/v1'));
  const v2ApiRouter = barabara.createRouter(path.join(__dirname, 'controllers/v2'));

  const app = express();

  app.use('/auth', authRouter);
  app.use('/v1', authMiddleware, v1ApiRouter);
  app.use('/v2', authMiddleware, v2ApiRouter);

Expectation

Barabara expect controller action's methods to have the following signature:

actionName(params: Object, meta: Object)

Exemple of controller implementation :

module.exports = {
  exists: async (params, meta) => { /* ... */ },
  read: async (params, meta) => { /* ... */ },
  create: async (params, meta) => { /* ... */ },
  update: async (params, meta) => { /* ... */ },
  partial: async (params, meta) => { /* ... */ },
  destroy: async (params, meta) => { /* ... */ },
  // This won't be mapped to a route
  internal: () => { /* ... */ }
};

Return behaviors

• If you return an object without barabara.redirect key in it, it will respond normally
• If you return an object with barabara.redirect key in it, it will redirect to the value
• If you return an object with barabara.contentType and a buffer, it will respond with the right Content-Type header
• If you return a non-object, it will respond this non-object (html for example)

Note: not all the methods need to be implemented

req.query, req.body, req.params will be merged in params (in this order). While meta will contains other req properties if specified in createRouter. meta will contain req.user here:

const authRouter = barabara.createRouter(
  path.join(__dirname, 'controllers/auth'), [ 'user' ]
);

OpenAPI Support in BaraBara

BaraBara now features comprehensive OpenAPI 3.0.1 specification support, allowing you to automatically generate API documentation from your controller configurations.

Getting Started

To enable OpenAPI documentation for your BaraBara application, simply provide an OpenAPI configuration object when initializing BaraBara:

const { Barabara } = require('barabara');
const { Router } = require('express');

// Define your actions map
const actionsMap = {
  read: 'get',
  create: 'post',
  update: 'put',
  partial: 'patch',
  destroy: 'delete'
};

// Configure OpenAPI documentation
const openApiConfig = {
  title: 'My API',
  version: '1.0.0',
  description: 'API documentation for my application',
  servers: [
    { url: 'https://api.example.com', description: 'Production server' },
    { url: 'https://staging-api.example.com', description: 'Staging server' }
  ],
  tags: [
    { name: 'users', description: 'User management' },
    { name: 'products', description: 'Product management' }
  ]
};

// Initialize BaraBara with OpenAPI support
const barabara = new Barabara(Router, actionsMap, openApiConfig);

// Create router with OpenAPI documentation endpoint
const router = barabara.createRouter('./controllers');

// Use the router in your Express app
app.use(router);

Documenting Controllers

To add OpenAPI documentation to your controllers, include an openApi property in your controller:

// controllers/users.js
module.exports = {
  // Controller methods
  read: async (options, meta) => {
    // Implementation
    return { users: [] };
  },

  create: async (options, meta) => {
    // Implementation
    return { created: true };
  },

  // OpenAPI documentation
  openApi: {
    // Action-specific documentation
    read: {
      summary: 'Get users',
      description: 'Retrieve a list of users',
      tags: ['users'],
      responses: {
        '200': {
          description: 'List of users',
          content: {
            'application/json': {
              schema: {
                $ref: '#/components/schemas/UserList'
              }
            }
          }
        },
        '401': {
          $ref: '#/components/responses/Unauthorized'
        }
      }
    },

    create: {
      summary: 'Create user',
      description: 'Create a new user',
      tags: ['users'],
      requestBody: {
        required: true,
        content: {
          'application/json': {
            schema: {
              $ref: '#/components/schemas/UserInput'
            }
          }
        }
      },
      responses: {
        '201': {
          description: 'User created successfully',
          content: {
            'application/json': {
              schema: {
                $ref: '#/components/schemas/UserCreated'
              }
            }
          }
        }
      }
    },

    // Reusable components
    components: {
      schemas: {
        UserList: {
          type: 'object',
          properties: {
            users: {
              type: 'array',
              items: {
                $ref: '#/components/schemas/User'
              }
            }
          }
        },
        User: {
          type: 'object',
          properties: {
            id: { type: 'string' },
            name: { type: 'string' },
            email: { type: 'string' }
          }
        },
        UserInput: {
          type: 'object',
          required: ['name', 'email'],
          properties: {
            name: { type: 'string' },
            email: { type: 'string' }
          }
        },
        UserCreated: {
          type: 'object',
          properties: {
            created: { type: 'boolean' }
          }
        }
      },
      responses: {
        Unauthorized: {
          description: 'Authentication required',
          content: {
            'application/json': {
              schema: {
                type: 'object',
                properties: {
                  error: { type: 'string' }
                }
              }
            }
          }
        }
      },
      parameters: {
        userId: {
          name: 'id',
          in: 'path',
          required: true,
          schema: {
            type: 'string'
          },
          description: 'User identifier'
        }
      }
    }
  }
};

Authentication & Security

To document authentication requirements, include a security property in your OpenAPI configuration:

const openApiConfig = {
  // Basic OpenAPI info
  title: 'My API',
  version: '1.0.0',
  description: 'API documentation',
  servers: [{ url: 'https://api.example.com' }],

  // Security schemes
  security: {
    bearerAuth: {
      type: 'http',
      scheme: 'bearer',
      bearerFormat: 'JWT',
      requirements: ['get:path', 'post:path']
    },
    apiKeyAuth: {
      type: 'apiKey',
      in: 'header',
      name: 'X-API-Key',
      requirements: []
    }
  }
};

Accessing the OpenAPI Documentation

When OpenAPI is enabled, BaraBara automatically adds an endpoint at /openapi that serves the complete OpenAPI specification in JSON format.

You can use this endpoint with tools like Swagger UI, Redoc, or Stoplight Studio to visualize and interact with your API documentation.

Components Registration

BaraBara automatically registers all OpenAPI components defined in your controllers:

• Schemas: Define data models
• Responses: Define reusable response objects
• Parameters: Define common parameters
• Security Schemes: Define authentication methods

These components can be referenced in your endpoint documentation using the standard OpenAPI $ref syntax.

Error Handling

BaraBara performs validation on your OpenAPI configuration and will throw descriptive errors if it detects issues, such as:

• Missing required properties in the OpenAPI config
• Invalid component types
• Invalid security configurations

These validations help ensure your OpenAPI documentation remains consistent and standards-compliant.

Npm scripts

Running code formating

npm run format

Running tests

npm test

Running lint tests

npm test:lint

Running coverage tests

npm test:cover

This will create a coverage folder with all the report in coverage/index.html

Running all tests

npm test:all

Note: that's the one you want to use most of the time

Reporting bugs and contributing

If you want to report a bug or request a feature, please open an issue. If want to help us improve barabara, fork and make a pull request. Please use commit format as described here. And don't forget to run npm run format before pushing commit.

Repository

• https://github.com/webinmove/barabara

License

The MIT License (MIT)

Copyright (c) 2019 WebInMove

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.