Page Comparison

...

...

Introduction

...

The following is a simple example service built using SOAJS, containing a number of APIs, each of which uses a different method: GET, POST, PUT, and DEL.

...

Example01 can be found inside the soajs.examples/example01/.

Code Walkthrough

...

This page shows you how to interact with example01 service after you install it and run it.

The code walkthrough is located in a sub page and explained in depth. You can click on this link to learn more about how the code works.

Start The Service

...

# go to correct directory
cd /opt/soajs/node_modules/soajs.examples/example01/

# export necessary environment variables
export SOAJS_PROFILE=/opt/soajs/node_modules/soajs.utilities/data/getStarted/profile.js
export SOAJS_ENV=test
export SOAJS_SRVIP=127.0.0.1

# start service
node .

...

{"result":true,"ts":1425054123486,"service": {"service":"example01","type":"rest","route":"/heartbeat"}}

Using the service APIs

Having checked the health of the service, let's invoke the remaining APIs.

...

"testGet" API: Failure

The first API to test is the "TestGet". In this scenario, the request is sent with only the "firstName" input. The request does not contain the second mandatory input: "lastName". So we expect the response to return with an error.

...

{"result": false,"errors": {"codes": [172],"details": [{"code": 172,"message": "Missing required field: lastName"}]}}

"testGet" API: Success

In this scenario, the request is sent with all the required input. The response should be a a JSON object containing the searched for object.

...

{"result": true,"data": {"firstName": "John","lastName": "Smith"}}

"testPost" API: Success

This API is exactly like testGet but uses the "post" method.

curl -X POST -H "Content-type:application/json" -H "Accept:application/json" "http://127.0.0.1:4010/testPost" -d '{"firstName":"John","lastName":"Smith","email":"john@smith.com"}'

...

{"result": true,"data": {"firstName": "John","lastName": "Smith","email": "john@smith.com"}}

"testPost" API: Failure

This request fails because of the invalid firstName "johnx" (Instead of "john"). This restriction is specified in the service itself.

...

{"result": false,"errors": {"codes": [900],"details": [{"code": 900,"message": "firstName not found"}]}}

"testPut" API: Success

SOAJS also provides supports the PUT method:

...

{"result": true,"data": {"firstName": "John","lastName": "Smith"}}

"testDel" API: Success

SOAJS also provides supports the DEL protocol:

...

{"result": true,"data": true}

"buildName" API: Success

This API receives a "firstName" and a "lastName" parameters, and returns the resulting fullName. However, the "firstName" parameter is not required, and if it is not sent within the request, the API has a default value to replace the missing one.

...

{"result": true,"data": {"fullName": "James Smith"}}

curl -X GET "http://127.0.0.1:4010/buildName?lastName=Smith"

{"result": true,"data": {"fullName": "John Smith"}}