REST Web Services Template

This template provides an example of how to create REST Web Services in NodeRun. Two Web Services are bundled with this template:

• list.js retrieves a customer list from a database table
• getCustomer.js retrieves information about a specific customer

All CRUD functions for the Employee table within the Employees folder:

• addEmployee.js add a single employee
• deleteEmployee.js delete a specific employee
• getEmployee.js retrieves information about a specific employee
• getEmployees.js retrieves a list of employees
• updateEmployee.js update information about a specific employee

Web Services URI

The URL's for these CRUD fuctions of the Employee table are:

• GET (get List) --> https://noderun.com/run/scotroach/rest-web-services/employees
• GET (get Single) --> https://noderun.com/run/scotroach/rest-web-services/employees/1056
• PUT with body (Add single) --> https://noderun.com/run/scotroach/rest-web-services/employees
• DELETE (delete Single) --> https://noderun.com/run/scotroach/rest-web-services/employees/9999
• POST with body (Update single) --> https://noderun.com/run/scotroach/rest-web-services/employees/1056

Look at the file Properties window, you can see mark a file as a Web Service, and specify the HTTP Method and Route Path.

Testing

This template provides a Node.js module and interface to test the Web Services. Simply select the Launch App option to run the test.

The test uses server-side requests to communicate with the services; however, client-side AJAX requests would work just as well. You can try testing the Web Services using client-side requests by navigating to the appropriate URL in your browser or by using a tool like Postman.

Request and Response Objects

The web server used for NodeRun is Profound.js, which is a superset of Express. Express provides various capabilities for receiving input and sending output using special Request and Response objects. You can refer to the Express API reference for the various properties and methods provided by these objects.

exports.default

NodeRun expects that your Node.js file exports a property named 'default' or 'run', which must point to the main function to execute when the module is called.

API

• pjs.query() - Execute an SQL query
• pjs.sendRequest() - Send request to a Web Service
• display.grid.replaceRecords() - Clear and add records to a Rich Display Grid