System and method to test executable instructions

• US 9,015,532 B2
• Filed: 10/31/2008
• Issued: 04/21/2015
• Est. Priority Date: 10/31/2008
• Status: Active Grant

• Current Assignee: PayPal, Inc. (PayPal Holdings, Inc.)
• Original Assignee: eBay Inc.
• Inventors: Hong, Lei
• Primary Examiner(s): TRUONG, LOAN
• Application Number:
  US13/126,719
• Publication Number:
  US 20110264961A1
• Time in Patent Office: 2,363 Days
• Field of Search: 714/38.1, 714/28
• US Class Current: 714/38.1
• CPC Class Codes: G06F 11/3684 for test design, e.g. generating new test cases
• CPC Class Codes: G06F 11/3688 for test execution, e.g. scheduling of test suites
• CPC Class Codes: H04L 43/50 Testing arrangements

Abstract

This document discusses, among other things, a method of testing an Application Programming Interface (API) call that includes receiving data identifying a schema associated with web services together with an API call. Various example embodiments may relate to accessing a data repository associated with the schema to identify an API response corresponding to the API call. In some example embodiments, a message is returned that is based on a determination of whether the API call is valid. The example message may simulate an API response from web services.

Claims

1. A method of testing an application programming interface (API) call, comprising:

receiving a test API call to access at least one web service, the test API call indicating a schema associated with the at least one web service;

validating the test API call based on the schema;

simulating an API response for the validated test API call that would be generated by the at least one web service had the at least one web service received and processed the test API call, the simulated API response including sample data; and

providing the simulated API response.

2. The method of claim 1, wherein the test API call includes at least one input field.

3. The method of claim 2, wherein validating the test API call includes verifying at least one of:

that the input field is populated with at least one value;

or

that the input field is associated with a valid extensible markup language (XML) schema data type.

4. The method of claim 1, wherein the test API call corresponds to instructions executable by the at least one web service to perform a function.

5. The method of claim 1, wherein the validating of the test API call includes validating the test API call based on syntax of the schema.

6. The method of claim 1, wherein simulating the API response includes generating the simulated API response including at least one output field populated with a value.

7. The method of claim 1, further comprising:

returning an error message based on invalidating the test API call that is not consistent with syntax of the schema.

8. The method of claim 7, wherein the receiving of the test API call includes receiving the test API call via a world wide web (WWW) from a web browser, and the returning the error message includes returning the simulated API response or the error message to the web browser.

9. The method of claim 7, wherein the receiving of the test API call includes receiving the test API call via a world wide web (WWW) from a desktop interface, and the returning of the error message includes returning the simulated response or the error message to the desktop interface.

10. A non-transitory machine-readable medium storing instructions, which when executed by the least one processor performs a method of testing an application programming interface (API) call, the method comprising:

receiving a test API call to access at least one web service, the test API call indicating a schema associated with the at least one web service;

validating the test API call based on the schema;

simulating an API response for the validated test API call that would be generated by the at least one web service had the at least one web service received and processed the API call, the simulated API response including sample data; and

providing the simulated API response.

11. The non-transitory machine-readable medium of claim 10, wherein the test API call includes at least one input field.

12. The non-transitory machine-readable medium of claim 11, wherein validating the test API call includes verifying at least one of:

that the input field is populated with at least one value;

or

that the input field is associated with a valid extensible markup language (XML) schema data type.

13. The non-transitory machine-readable medium of claim 10, wherein the test API call corresponds to instructions executable by the at least one web service to perform a function.

14. The non-transitory machine-readable medium of claim 10, wherein the validating of the API call includes validating the test API call based on syntax of the schema.

15. The non-transitory machine-readable medium of claim 10, wherein simulating the API response includes generating at least one output field populated with a value.

16. The non-transitory machine-readable medium of claim 10, further comprising:

returning an error message based on invalidating the test API call that is not consistent with syntax of the schema.

17. A response simulator to test an Application Programming Interface (API) call, the response simulator comprising:

a communication interface to be communicatively coupled to a user interface and to receive from the user interface;

a test API call to access at least one web service, the test API call indicating a schema associated with the at least one web service;

a validation module communicatively coupled to the communication interface to determine whether the test API call is valid; and

a response module communicatively coupled to the validation module and to the communication interface to;

simulate an API response for the validated test API call that would be generated by the at least one web service had the at least one web service received and processed the test API call, the simulated API response including sample data, and

provide the simulated API response.

18. The response simulator of claim 17, wherein the test API call includes at least one input field populated with a value.

19. The response simulator of claim 18, wherein the validation module is to determine the valid test API call based on verifying at least one of:

that the input field is populated with at least one value;

or

that the input field is associated with a valid extensible markup language (XML) schema data type.

20. The response simulator of claim 17, wherein the test API call corresponds to instructions executable by the web services to perform a function.

21. The response simulator of claim 17, wherein the validation module is to validate the test API call based on syntax of the schema.

22. The response simulator of claim 17, wherein the response module is to indicate failure or partial success of the test API call, based on comparing the test API call with syntax of the schema.

23. The response simulator of claim 22, wherein the communication module is to receive the test API call via a world wide web (WWW) from a web browser, and the communication module is to return an indication of failure or partial success of the test API call to the web browser via the WWW.

24. The response simulator of claim 22, wherein the communication module is to receive the test API call via a world wide web (WWW) from a desktop program interface, and the communication module is to return an indication of failure or partial success of the test API call to the desktop program interface via the WWW.

25. The response simulator of claim 17, wherein the response module is to generate the simulated API response that includes at least one output field populated with a value.

26. The response simulator of claim 17, wherein the response simulator is integrated into a desktop program via installation of a plugin to the desktop program, wherein the desktop program is included within the user interface.

27. A system to test an application programming interface (API) call, comprising:

receiving means for receiving a test API call to access at least one web service, the test API call indicating a schema associated with the at least one web service;

validating means for validating the test API call based on the schema;

simulating means for simulating an API response for the validated test API call that would be generated by the at least one web service had the at least one web service received and processed the test API call; and

responsive means for providing the simulated API response.