Design and Build Great Web APIs/

...

/

DARRT Project: Data

DARRT Project: Data

Learn how to start a DARRT project and what data is in DARRT.

We'll cover the following...

DARRT framework setup

In this lesson, we’ll first initialize the DARRT library in our API project. The DARRT library holds several internal modules that handle the behind-the-scenes work along with a set of five key modules that we’ll use to define and implement the desired API.

First, we need to copy the contents of the darrt folder in the root folder of the onboarding-api project folder. We’ve already done this for you. Here is what the contents of the darrt folder look like:

/***
 * Excerpted from "Design and Build Great Web APIs",
 * published by The Pragmatic Bookshelf.
 * Copyrights apply to this code. It may not be used to create training material,
 * courses, books, articles, and the like. Contact us if you are in doubt.
 * We make no guarantees that this code is fit for any purpose.
 * Visit http://www.pragmaticprogrammer.com/titles/maapis for more book information.
***/
/*****************************************
// bigco, inc 
// action elements
// onboarding
// 2020-02-01 : mamund
 *****************************************/

var component = require('./lib/component');
var data = require('./data');

/***************************************** 
// actions for the onboarding service
 *****************************************/

module.exports.home = function(req,res) {
  return new Promise(function(resolve,reject) {
    var body = []; 
    
    // hack to handle empty root for non-link types
    ctype = req.get("Accept")||"";
    if("application/json text-csv".indexOf(ctype)!==-1) {
      body = {
        id:"list",
        name:"onboarding",
        rel:"collection onboarding",
        href: "{fullhost}/list/"
      };
    }
    
    if(body) {
      resolve(body);
    }
    else {
      reject({error:"invalid body"});
    }
  });
}

module.exports.createWIP = function(req,res) {
  return new Promise(function(resolve,reject) {
    var body = req.body||{};
    if(body) {
     resolve(
      component(
        { 
          name:'onboarding',
          action:'add',
          item:body,
          props:data.props,
          reqd:data.reqd, 
          enums:data.enums
        }
       )
     );
    }
    else {
      reject({error:"invalid body"});
    }
  });
};

module.exports.listWIP = function(req,res) {
  return new Promise(function(resolve,reject) {
    resolve(component({name:'onboarding',action:'list'}));
  });
}

module.exports.filterWIP = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.query && req.query.length!==0) {
      resolve(component({name:'onboarding',action:'filter',filter:req.query}));
    }
    else {
      reject({error:"invalid query string"});
    }
  })
}

module.exports.readWIP = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      resolve(component({name:'onboarding',action:'item',id:id}));
    } 
    else {
      reject({error:"missing id"});
    }
  });
}

module.exports.readCompany = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      var fields=`id, status, dateCreated, dateUpdated, companyId, companyName, 
        streetAddress, city, stateProvince, country, telephone, email`
      resolve(component({name:'onboarding',action:'item',id:id, fields:fields}));
    } 
    else {
      reject({error:"missing id"});
    }
  });
}

module.exports.writeCompany = function(req,res) {
  var id,body;
  return new Promise(function(resolve,reject){
    id = req.params.id||null;
    body = req.body||null;
    if(id!==null && body!==null) {
       resolve(component(
         {name:'onboarding',
          action:'update',
          id:id,
          item:body,
          props:data.props,
          reqd:data.reqd,
          enums:data.enums}));
     }
     else {
       reject({error:"missing id and/or body"});
     }
  });
}

module.exports.readAccount = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      var fields=`id, status, dateCreated, dateUpdated, 
        accountId, division, spendingLimit, discountPercentage`
      resolve(component({name:'onboarding',action:'item',id:id, fields:fields}));
    } 
    else {
      reject({error:"missing id"});
    }
  });
}

module.exports.writeAccount = function(req,res) {
  var id,body;
  return new Promise(function(resolve,reject){
    id = req.params.id||null;
    body = req.body||null;
    if(id!==null && body!==null) {
       resolve(component(
         {name:'onboarding',
          action:'update',
          id:id,
          item:body,
          props:data.props,
          reqd:data.reqd,
          enums:data.enums,
          fields:fields}));
     }
     else {
       reject({error:"missing id and/or body"});
     }
  });
}

module.exports.readActivity = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      var fields=`id, status, dateCreated, dateUpdated, 
        activityId, activityType, dateScheduled, notes`
      resolve(component({name:'onboarding',action:'item',id:id, fields:fields}));
    } 
    else {
      reject({error:"missing id"});
    }
  });
}

module.exports.writeActivity = function(req,res) {
  var id,body;
  return new Promise(function(resolve,reject){
    id = req.params.id||null;
    body = req.body||null;
    if(id!==null && body!==null) {
       resolve(component(
         {name:'onboarding',
          action:'update',
          id:id,
          item:body,
          props:data.props,
          reqd:data.reqd,
          enums:data.enums}));
     }
     else {
       reject({error:"missing id and/or body"});
     }
  });
}

module.exports.readStatus = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      var fields="id, status, dateCreated, dateUpdated" 
      resolve(component({name:'onboarding',action:'item',id:id, fields:fields}));
    } 
    else {
      reject({error:"missing id"});
    }
  });
}

module.exports.writeStatus = function(req,res) {
  var id,body;
  return new Promise(function(resolve,reject){
    id = req.params.id||null;
    body = req.body||null;
    if(id!==null && body!==null) {
       resolve(component(
         {name:'onboarding',
          action:'update',
          id:id,
          item:body,
          props:data.props,
          reqd:data.data,
          enums:data.enums}));
     }
     else {
       reject({error:"missing id and/or body"});
     }
  });
}

/*
module.exports.remove = function(req,res) {
  return new Promise(function(resolve,reject){
    if(req.params.id && req.params.id!==null) {
      var id = req.params.id;
      resolve(component(
        {name:'company',action:'delete', id:id}));
    }
    else {
      reject({error:"invalid id"});
    }
  });
}
*/
Contents of the darrt folder

We’ll edit only the top-level files in this collection. Everything in the lib and representors folders are just support routines.

After copying that folder into the root of our project, we also need to initialize the index.js file to the root. This will be the file that pulls things together and launches the Node.js project at runtime. That file looks like this:

Press + to interact
/*****************************************
// BigCo Inc. onboarding
// root of the Service API
// 2020-02-01 : mamund
 *****************************************/
 
var express = require('express');
var app = express();
var cors = require('cors');
var resources = require('./darrt/resources');
var port = process.env.PORT || 8080;
// support calls from JS in browser
app.use(cors());
app.options('*',cors()); 
// point to exposed resources for this API
app.use('/',resources); 
// start listening for requests
app.listen(port, () => console.log(`listening on port ${port}!`));
...