API validation system

Patent metadata

Field	Value
Publication number	US-9552237-B2
Application number	US-201514836428-A
Country	US
Kind code	B2
Filing date	Aug 26, 2015
Priority date	Nov 26, 2014
Publication date	Jan 24, 2017
Grant date	Jan 24, 2017

Abstract

A system that validates an application programming interface (API) call is provided. A key and a value associated with the key are read from a test script containing a script. The key and the value are separated by a colon. The key is included in first double quotes, and the value is included in second double quotes. Whether the key matches a plurality of keys defined for an API call is determined. Based on the key matching the plurality of keys defined for the API call, the API call is configured using the key and the value without any of the colon, the first double quotes, or the second double quotes. The configured API call is executed.

First claim

What is claimed is:

1. A non-transitory computer-readable medium having stored thereon computer-readable instructions that when executed by a computing device cause the computing device to:
read a first key and a first value associated with the first key from a test script containing a script, wherein the first key and the first value are separated by a colon and the first key is included in first double quotes and the first value is included in second double quotes to form a first JavaScript Object Notation (JSON) name/value pair;
determine whether the first key matches a plurality of keys defined for an application programming interface (API) call;
based on the first key matching the plurality of keys defined for the API call, configure the API call using the first key and the first value and removing the colon, the first double quotes, and the second double quotes;
execute the configured API call;
receive a response value from the executed API call;
read a second key and a second value associated with the second key from the test script, wherein the second key and the second value are separated by a second colon and the second key is included in third double quotes to form a second JSON name/value pair; and
based on the second key matching an assert key,
parse the second value into a third key and a third value, wherein the third value defines an expected response to the API call, wherein the third value is a third JSON name/value pair;
map the second key and the third key to an implementation class of a programming language, wherein the implementation class tests whether an assertion is true or false;
instantiate the implementation class;
call a method of the instantiated implementation class, wherein the third value is passed as an input to the method, wherein the method compares the third value with the received response value;
receive an assertion result indicator from the called method; and
indicate a success or a failure of the API call based on the received assertion result indicator.

2. The computer-readable medium of claim 1 , wherein the first key indicates a hypertext transfer protocol verb.

3. The computer-readable medium of claim 1 , wherein the test script includes a plurality of scripts, wherein each script of the plurality of scripts starts with a left curly brace and ends with a right curly brace to form a JSON object.

4. The computer-readable medium of claim 1 , wherein the computer-readable instructions further cause the computing device to:
read a fourth key and a fourth value associated with the fourth key from the test script,
wherein the fourth key and the fourth value are separated by a third colon and the fourth key is included in fourth double quotes.

5. The computer-readable medium of claim 4 , wherein the fourth value is included in fifth double quotes,
wherein the fourth value indicates a name of a second script included in the test script to merge into the script.

6. The computer-readable medium of claim 4 , wherein the fourth value is a key-value pair that forms a fourth JSON name/value pair,
wherein the key-value pair includes a fifth key and a fifth value separated by a fourth colon and the fifth key is included in fifth double quotes and the fifth value is included in sixth double quotes.

7. The computer-readable medium of claim 4 , wherein the fourth value is an array of key-value pairs,
wherein each key-value pair of the array of key-value pairs includes a fifth key and a fifth value separated by a fourth colon and the fifth key is included in fifth double quotes.

8. The computer-readable medium of claim 4 , wherein the fourth value is a plurality of key-value pairs,
wherein each key-value pair of the plurality of key-value pairs includes a fifth key and a fifth value separated by a fourth colon and the fifth key is included in fifth double quotes and the fifth value is included in sixth double quotes.

9. The computer-readable medium of claim 4 , wherein the fourth value is a key-value pair,
wherein the key-value pair includes a fifth key and a fifth value separated by a fourth colon and the fifth key is included in fifth double quotes and the fifth value is a second key-value pair,
wherein the second key-value pair includes a sixth key and a sixth value separated by a fifth colon and the sixth key is included in sixth double quotes and the sixth value is included in seventh double quotes.

10. The computer-readable medium of claim 4 , wherein the fourth value includes a plurality of values with each value of the plurality of values included in fifth double quotes.

11. The computer-readable medium of claim 4 , wherein the computer-readable instructions further cause the computing device to:
based on the fourth key matching a template key,
identify a second script in the test script by matching the fourth value to a script name assigned to the second script using a name key; and
include the identified second script in the script.

12. The computer-readable medium of claim 4 , wherein the computer-readable instructions further cause the computing device to:
based on the fourth key matching an environment key,
parse the fourth value into a fifth key and a fifth value;
create a variable named using the fifth key; and
assign a variable value to the created variable using the fifth value.

13. The computer-readable medium of claim 1 , wherein the test script includes a plurality of scripts and the computer-readable instructions further cause the computing device to:
read a string from the script;
identify a second script from the plurality of scripts by matching the read string to a name of the second script; and
execute the identified second script.

14. The computer-readable medium of claim 1 , wherein the test script includes a plurality of scripts and the computer-readable instructions further cause the computing device to:
read a string from the script;
determine that the read string indicates a name of a file that includes a second script;
open the file using the indicated name; and
parse the second script by reading the open file.

15. The computer-readable medium of claim 1 , wherein the test script includes a plurality of scripts and the computer-readable instructions further cause the computing device to:
read a string from the script;
determine that the read string indicates a name of a uniform resource identifier (URI) that includes a second script; and
parse the second script by accessing the URI.

16. A computing device comprising:
a processor; and
a computer-readable medium operably coupled to the processor, the computer-readable medium having computer-readable instructions stored thereon that, when executed by the processor, cause the computing device to
read a first key and a first value associated with the first key from a test script containing a script, wherein the first key and the first value are separated by a colon and the first key is included in first double quotes and the first value is included in second double quotes to form a first JavaScript Object Notation (JSON) name/value pair;
determine whether the first key matches a plurality of keys defined for an application programming interface (API) call;
based on the first key matching the plurality of keys defined for the API call, configure the API call using the first key and the first value and removing the colon, the first double quotes, and the second double quotes;
execute the configured API call;
receive a response value from the executed API call;
read a second key and a second value associated with the second ke

Assignees

• Sas Inst Inc

Inventors

• Biesack David James

Classifications

• H04L67/02

  based on web technology, e.g. hypertext transfer protocol [HTTP] · CPC title

• G06F9/541 Primary

  via adapters, e.g. between incompatible applications · CPC title