puivid01

About This Space

map demo


Last updated on June 7, 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 Jeff Berman (@jeff)

Filters:

Popular Recent

A Hello World app with both dynamic output and input fields

3326

0

This is just the hello world template for me to test various NodeRun things with. Nothing to see here, move along... :-)

3826

0

0

A demonstration of some of the client-side grid functions that could be used in an offline mobile environment.

1110

0

0

Simple space to demonstrate what appears to be a rendering bug in mobile Safari. Run this space on an iPhone running 12.2 or higher, rotate the phone to landscape, then rotate back to portrait. If the issue occurs, there will be an unusable white space at the bottom of the screen.

4316

0

0

Stateless demo app, where the mobile client or the browser would control the flow of the application

3240

0

0

Stateless demo app, where the mobile client or the browser would control the flow of the application

3174

0

0

Stateless demo app, where the mobile client or the browser would control the flow of the application

3816

0

0

Stateless demo app, where the mobile client or the browser would control the flow of the application

3009

0

0

Static HTML Hello World App

3297

0

0

Simple page to test voice dictation not working in iOS 13

3563

0

0

Test an issue with programmatically checking checkboxes

3560

0