@italojs/bigbang-rest

    0.2.2 • Public • Published

    bigbang-rest

    Express API bootstrap as module.

    This module will contemple all base of api's cofiguration, all apis must be this configuration and patterns.

    Whay use bigbang-rest?

    It help us to have a ubiquitous language and a api development pattern. This module have all express apis middlweares, configurations and a ping route.

    Getting Started

    These instructions will get you how to install it and use on your projects.

    Prerequisites

    • "node >= 8.10.0"
    • "npm >= 5.8.0"

    Installing

    First install the package on your project.

    npm install @italojs/bigbang-rest

    Setup your api

    After you have intalled the package @italojs/bigbang-rest, require it at your index.js

    const bigbang = require('@iatlojs/bigbang-rest')

    or

    const { factory } = require('@italojs/bigbang-rest')

    The bigbang-rest constant or the factory constant is a function that receive a callback function. The factory/bigbang-rest function return a express instance app, inside this function have all the express configuration like middlewares, ping route, log format... The callback function is like an configuration extension to express package, it's contain your own middlewares and routes. This callback function is called at middle of the middlewares:

    [ Inside the @italojs/bigbang-rest ]

    [...]
    const app = express()
     
    app.use(middlewares.morgan.factory(config.morgan))
    app.use(middlewares.parsers.urlencoded.factory())
    app.use(middlewares.parsers.json.factory())
    app.use(middlewares.helmet.factory())
     
    app.get('/ping', routes.ping.factory(config, environment))
     
    // Your callback function here
    fn(app, config, environment, logger)
     
    app.use('*', middlewares.routes.unmatched.factory())
    app.use(middlewares.validation.errors.factory())
    app.use(middlewares.struct.errors.factory())
    app.use(middlewares.stderr.factory(logger))
    app.use(middlewares.normalizer.factory())
    app.use(middlewares.renderer.factory())
    [...]

    So, after required the @italojs/bigbang-rest call the function factory and set the callback parameter. This callback parameter receive a express instance, config object, environment and logger object.

    So your index.js is:

    'use strict'
     
    const bigbang = require('@italojs/bigbang-rest')
    const datase = require('../your/database/path')
    const config = require('../your/configJson/path')
     
    /**
     * Application setup.
     * @param  {Object} api                 Express instance.
     * @param  {Object} options.config      Application configs.
     */
    module.exports = bigbang((api, config) => {
      // The database factory is only to illustration.
      // The bigbang-rest package don't control your database instance.
      const { repositories, storages } = database.factory(config.mongodb)
     
      api.post('/', (storages) => {[
        rescue(async (req, res) => {
            //Do the magic!
            res.status(201)
               .json(data)
        })
      ]})
     
      api.get('/', (repositories) => {[
        rescue(async (req, res) => {
            //Do the magic!
            res.status(200)
               .json(data)
        })
      ]})
     
      api.delete('/:parameter', (storages) => {[
        rescue(async (req, res) => {
            await storages.someStorageInstance.delete(req.params.parameter)
            res.status(204)
               .end()
        })
      ]})
    })

    it's only an example, please, read the 'GoodPratices' file to code it better.

    About more bigbang-rest

    Default Middlwares:

    Config

    At factory method, we have a default configuration object that merge it the with your custom configuration object

    [...]
    const factory = (fn) => {
      /**
       * @function
       * @param  {Object} options     Configurations object from config.js file.
       * @param  {String} environment Current environment name.
       * @return {Object}             Instance of express app.
       */
      return (options, environment) => {
        const config = merge({
          name: env.get(['APP_NAME', 'npm_package_name'], 'app'),
          version: env.get('GIT_RELEASE'),
          morgan: {
            format: ':method :url :status :: :response-time ms',
            skip: (req, res) => environment !== 'development'
          },
          stackdriver: {
            enabled: booleanlike(env.get('STACKDRIVER_ENABLED', false))
          }
        }, options)
     
    [...]

    You can create a custom config json and send it as parameter to factory function. That config file will be merged with default config..

    [...]
    /**
     * Application setup.
     * @param  {Object} api                 Express instance.
     * @param  {Object} options.config      Application configs.
     */
    module.exports = bigbang((api, config) => {
      // The database factory is only to illustration.
      // The bigbang-rest package don't control your database instance.
      const { repositories, storages } = database.factory(config.mongodb)
      [...]

    Why bigbang-rest name?

    It's a reference to bigbang-rest, he is a fictional character appearing in American comic books published by Marvel Comics. Created by writer/artist Jim Starlin, the character first appeared in The Invincible Iron Man #55 (cover dated February 1973).

    The character appears in various Marvel Cinematic Universe films, portrayed by Damion Poitier in The Avengers (2012), and by Josh Brolin in Guardians of the Galaxy (2014), Avengers: Age of Ultron (2015), Avengers: Infinity War (2018), and the fourth Avengers film (2019) through voice and motion capture.

    Coding style

    bigbang-rest package use Standard style guide, see more about at this 'link'

    Up the server

    After setup your index.js app file, let start the server into a other file called bin/www, import the bigbang-rest's server object and call the start mathod sending a express instance and a config file(optinal).

    const app = require('../your/index/app/path')
    const config = require('../your/config/path'')
    const { server } = require('../../../packages/appify')
     
    server.start(app, config)

    Contributing

    Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

    Versioning

    We use SemVer for versioning. For the versions available, see the tags on this repository.

    Authors

    • *Italo josé - Initial work - italojs

    See also the list of contributors who participated in this project.

    License

    Don't have a license yet

    Keywords

    none

    Install

    npm i @italojs/bigbang-rest

    DownloadsWeekly Downloads

    8

    Version

    0.2.2

    License

    none

    Unpacked Size

    26.3 kB

    Total Files

    34

    Last publish

    Collaborators

    • italojs