REST Example

Alex (@alex)

31641

0

0

About This Space

A demo of how to build and consume Web Services with and without parameters


Last updated on January 5, 2019

Public Permissions:   View   Open/Fork   Run   Comment  

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

Web Services URI

The URI format for the Web Services is:

https://noderun.com/run/[your profile]/[your space name]/[route]/[params]

Before you can run the Web Service, you must create a NodeRun profile and publish a space. The route and params are defined by right-clicking the Node.js file in the Files tree and selecting Properties.

Screenshot

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

Screenshot

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.

Screenshot

Screenshot

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.run

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

API

Be the first to comment:      

Comments

Write Preview Markdown: bold italic code link
Post

More Spaces By Alex (@alex)

Filters:

Popular Recent

This workspace illustrates the basic setup of an HTML page that includes external JavaScript and CSS files

38256

0

0

Example of Indeterminate Checkbox

11306

0

0

39340

0

0

Low code employee maintenance

24677

0

0

22101

0

0

This app allows a team to decide where to go for lunch (or dinner) by using acceptance voting.

21521

0

0

This is the completed example for the Stateful To-Do List Application walkthrough (https://noderun.com/docs/walkthroughs/stateful_todo_list_app) and the starting point for the Drag and Drop walkthrough (coming soon). Please feel free to fork this workspace to use as a starting place for you own projects or for the walkthroughs.

23056

0

0

Leet Translator

44959

0

2

Displaying information in grids is fundamental to developing applications. This demo application displays a list of products in a grid.

39535

0

0

Displaying information in grids is fundamental to developing applications. This demo application displays a list of products in a grid.

38183

0

0

Displaying information in grids is fundamental to developing applications. This demo application displays a list of products in a grid.

37820

0

0

Displaying information in grids is fundamental to developing applications. This demo application displays a list of products in a grid.

36916

0

0