Testing RESTful services in ACCELQ – ACCELQ

ACCELQ provides comprehensive support for executing and verifying REST API. There isn't much difference in how you set up your action logic for API testing compared to UI testing. And you can also develop an Action that includes both UI and API testing together, making possible a fluid end-to-end verification.

Here is the basic flow involved in testing RESTful services. Subsequent sections describe these steps in greater detail.

Defining REST Connection

Define REST Connection

Registers ReST connection with the given name and base URL. Further API calls on this connection should be referenced through the given connection name. If the connection name already exists then the results will be overwritten with the new REST calls.

 Connection Name
 
 Base URL
 
 Authentication Headers
 (sticky headers)

Connection Name to reference when invoking REST calls
 
Base URL that is prefixed to the end-point URL of REST calls on this connection
 
Comma separated authentication header name/value pairs. 
These headers are passed as standard for all REST calls on this connection.
While invoking a REST request, you only need to pass headers specific to that request.
e.g. access_token,ax09d24xc,client_id,c187_333

Note: While inputting header name/value pairs with comma separation, if there is a legitimate comma character in the value of a particular header name, escape it with "\"

Invoking REST Calls

Invoke ReST Request (GET)

Invokes a ReSTful GET service. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of the Response.

Connection Name
 
Reference Name
 
URL

Headers

Connection name on which this REST call is executed.
 
Reference name for this ReST call

ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed.
 
Comma separated header-value pairs that are to be passed in the Request.

Invoke ReST Request (POST)

Invokes a ReSTful POST service. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of Response.

 Connection name 

 Reference name
 
 URL

 Headers
 
 Payload type
 
 Payload

 Connection name on which this REST call is executed.

 Reference name for this ReST call.
 
 ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed.

 Comma separated header-value pairs that are to be passed in the Request.
 
 Type of payload data. eg.application/json
 
 Payload Data

Invoke ReST Request (POST) With Form Data Type Payload

Invokes a ReSTful POST service with a Form input data payload. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of the Response.

 URL

 Connection name

 Reference name

 Headers
 
 Form data

 ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed. 

 Connection name on which this REST call is executed.

 Reference name for this ReST call.

 Comma separated header-value pairs that are to be passed in the Request.
 
 Form data

Invoke ReST Request (PUT)

Invokes a ReSTful PUT service. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of the Response.

URL

Reference name

Connection name

Headers 

Payload type

Payload

ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed.

Reference name for this ReST call.

Connection name on which this REST call is executed.

comma separated header-value pairs that are to be passed in the Request.

Type of payload data. eg.application/json

Payload

Invoke ReST Request (PUT) With Form Data Type Payload

Invokes a ReSTful PUT service with Form input data payload. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of Response.

URL
 
Connection name
 
Reference name
 
Headers
  
Form data

 ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed. 
 
 Connection name on which this REST call is executed.
 
 Reference name for this ReST call.
 
 Comma separated header-value pairs that are to be passed in the Request.
  
 Form data

Invoke ReST Request (PATCH)

Invokes a ReSTful PATCH service.

 URL
 
 Reference name
 
 Connection name
 
 Headers 
 
 Payload type
 
 Payload

 ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed.
 
 Reference name for this ReST call.
 
 Connection name on which this REST call is executed.
 
 comma separated header-value pairs that are to be passed in the Request.
 
 Type of payload data. eg.application/json
 
 Payload

Invoke ReST Request (DELETE)

Invokes a ReSTful DELETE service. Note that the connection name must have already been defined (and authenticated, if required) before executing this command. The Reference Name provided with this Request should be used for subsequent validation of Response.

 URL
 
 Reference name
 
 Connection name
 
 Headers 
 
 Payload type
 
 Payload

 ReST service end-point URL. Note that if the Connection has a base URL specified, it will be prefixed.
 
 Reference name for this ReST call.
 
 Connection name on which this REST call is executed.
 
 comma separated header-value pairs that are to be passed in the Request.
 
 Type of payload data. eg.application/json
 
 Payload

Note: If the information in a header is confidential, you may pass encrypted values instead of plain text.

Click on Resources in the left-nav and Tools > Encrypt Text. Copy the encrypted text for the header value.
Pass this encrypted value in the header in the format "$encr(<value>)"

Response Verification

Verify Header From ReST Response

Verifies header value from ReST Response.

reference name
 
header name
 
header value

failure action

reference name for this ReST call.
 
header name
 
expected header value to be verified

 select action to be done if verification fails (continue to execute the test or abort test).

Verify ReST Response Status Code

Verifies whether the Response status code for a given ReST Request is the specified value. Note that this is verification command and it fails the test execution if the verification fails.

Reference name
 
Status code

failure action

Reference name for the ReST call whose status to be verified 
 
Status code verified against Response's status code. 

Select action to be done if verification fails (continue to execute the test or abort test).

Verify Node In ReST Response Matches

Verify the node value in ReST response matches an expected text.

 Ref name
 
 Match type
 
 failure action
 
 Expected value
 
 Comparison type
 
 JSON Path

Reference name for this ReST call.
 
Select case sensitivity option (ignore case, match case, regex pattern)
 
Select action to be done if verification fails (continue to execute the test, abort test).
 
Expected value
 
Select matching option (equals, contains)
 
JSON Path to be verified

Verify Node In ReST Response Is Not

Verify the node value in ReST response does not matches a text.

 Ref name
 
 Match type
 
 failure action
 
 Expected value
 
 Comparison type
 
 JSON Path

Reference name for this ReST call.
 
Select case sensitivity option (ignore case, match case, regex pattern)
 
Select action to be done if verification fails (continue to execute the test, abort test).
 
Expected value
 
Select matching option (equals, contains)
 
JSON path to verify

Defining REST Connection

Invoking REST Calls

Response Verification

Related articles