System and method for performing automated API tests

An electronic device, comprising:

• one or more processors;
• and
• memory storing one or more programs for execution by the one or more processors, the one or more programs including instructions for:
• obtaining a plurality of API tests, and test data and validation data for the plurality of API tests;
• categorizing, in accordance with a data model, data required for testing the plurality of API tests, into a plurality of groups including test scenarios, test cases, an inventory of APIs, the test data, and the validation data;
• performing validation for each test of the plurality of API tests, wherein performing the validation includes:
• generating a test payload for a respective test, wherein generating the test payload includes:
• determining an API reference corresponding to the respective test;
• obtaining relevant data from the test data according to a reference key in the respective test;
• generating input assignment operations for one or more input parameters in the API reference according to the relevant data;
• and
• generating an API call based on the API reference;
• calling an endpoint corresponding to the respective test using the test payload;
• receiving a response from the endpoint for the test payload;
• and
• validating the response according to the validation data;
• and
• generating and outputting one or more test reports based on the validated responses;
• wherein performing the validation comprises:
• generating a first test payload for a first test of the plurality of API tests;
• calling a first endpoint corresponding to the first test using the first test payload;
• receiving a first response from the first endpoint for the first test payload;
• validating the first response according to the validation data;
• selecting a second test according to a result of the validation of the first response, the result of the validation of the first response indicating that the validation of the first response has passed or failed;
• generating a second test payload for the second test of the plurality of API tests according to the first response;
• calling a second endpoint corresponding to the second test using the second test payload;
• receiving a second response from the second endpoint for the second test payload;
• and
• validating the second response according to the validation data.

A non-transitory computer-readable storage medium storing one or more programs for execution by one or more processors of an electronic device, the one or more programs including instructions for:

• obtaining a plurality of API tests, and test data and validation data for the plurality of API tests;
• categorizing, in accordance with a data model, data required for testing the plurality of API tests, into a plurality of groups including test scenarios, test cases, an inventory of APIs, the test data, and the validation data;
• performing validation for each test of the plurality of API tests, wherein performing the validation includes:
• generating a test payload for a respective test, wherein generating the test payload includes:
• determining an API reference corresponding to the respective test;
• obtaining relevant data from the test data according to a reference key in the respective test;
• generating input assignment operations for one or more input parameters in the API reference according to the relevant data;
• and
• generating an API call based on the API reference;
• calling an endpoint corresponding to the respective test using the test payload;
• receiving a response from the endpoint for the test payload;
• and
• validating the response according to the validation data;
• and
• generating and outputting one or more test reports based on the validated responses;
• wherein performing the validation comprises:
• generating a first test payload for a first test of the plurality of API tests;
• calling a first endpoint corresponding to the first test using the first test payload;
• receiving a first response from the first endpoint for the first test payload;
• validating the first response according to the validation data;
• selecting a second test according to a result of the validation of the first response, the result of the validation of the first response indicating that the validation of the first response has passed or failed;
• generating a second test payload for the second test of the plurality of API tests according to the first response;
• calling a second endpoint corresponding to the second test using the second test payload;
• receiving a second response from the second endpoint for the second test payload;
• and
• validating the second response according to the validation data.

A method for ad-hoc batch testing of APIs, the method comprising:

• obtaining a plurality of API tests, and test data and validation data for the plurality of API tests;
• performing validation for each test of the plurality of API tests, wherein performing the validation includes:
• generating a test payload for the respective test, wherein generating the test payload includes:
• determining an API reference corresponding to the respective test;
• obtaining relevant data from the test data according to a reference key in the respective test, wherein the reference key indicates if one or more parameters in the API reference are hardcoded as constants or variables that need to be collected from the test data;
• generating input assignment operations for one or more input parameters in the API reference according to the relevant data;
• and
• generating an API call based on the API reference;
• calling an endpoint corresponding to the respective test using the test payload;
• receiving a response from the endpoint for the test payload;
• and
• validating the response according to the validation data;
• and
• generating and outputting one or more test reports based on the validated responses.