Tutorials and samples for Functional Testing in Ready API

Create a Test

1. Open the start page, select Create Functional Test, and then choose API Definition in the ensuing dialogue. 

2. Enter the URL for your web service's definition in the following wizard. The following URL will be used in this tutorial.

Select Next to continue.

3. Choose whether you want to add the definition you just added to an existing project or create a new one for it.

Note: The wizard will skip this step if your workspace has no open projects. In this situation, Ready API will start a fresh project and incorporate the fresh test into it.

Select Next to continue.

4.You can choose which assertions to include in the test on this page of the wizard. ReadyAPI adds the chosen assertions to fresh test requests.

5. Choose whether to use multiple or a single test case for every defined operation in your web service (one per each operation). 

Let's choose the latter:

Select Finish to create a test.

6. Ready API will do a test project, and test cases will be added.

 

Explore Test Project

🍁  The test project that was created is visible in the Navigator panel on the left: 

There are many test cases in the project (one per operation). Each of them is compiled into a test suite, which is part of the project.

 

🍁 In our case, there is only one request test step per test case. Your test cases will typically include more than one step in the real world:

Expand the APIs node in the Navigator panel to explore the service. The resources and requests for the service are displayed in a tree-like structure:

 

🍁 A web service corresponds to the node at the top. Resources are represented by their child nodes. The resource nodes each have child nodes compatible with requests that correspond to resources as defined in the web service specification.

 

🍁 Use the editor on the right to view the parameters of the chosen service, resource, or  request.

 

🍁 There are multiple defined requests for some resources. Usually, these requests use various HTTP methods. Other resources only have a single request. In APIs, the requests you see in the tree are template requests. As an illustration, you could change the parameters in each request here, then use these requests as the foundation for your  request test steps in the Functional Tests node.You can make as many templates for a request as you need for your project.

 

🍁 You can also run a request from the request editor to verify that this request is functioning properly. But keep in mind that this will be a one-off request run. You must run a test case with numerous requests to simulate a real scenarios We will modify request parameters and add a request to a test case in the following tutorial step.

Modify Functional Test

Add Request Test Step

1. Hover your mouse pointer over the /pet/findByStatus-Request 1 Test Case node in the Navigator tree on the left and click the hamburger icon ().

2. Choose the REST Request test step from the flyout menu. You can start typing the name in the Search field to find it quickly:

3. Enter the test step name, choose the template request for the test step you are creating, uncheck the assertion checkboxes, and then click Add Test Step in the ensuing dialogue

4. The request will be added to the test case:

Modify Request Parameters

We currently have two requests that mimic the same action. Let's alter their parameters to cause the requests to return various sets of information:

1. In the Navigator tree, select the GET Request test step.

2. Click somewhere in the Value cell of the status row in the request editor and enter available. To confirm the modification, press ENTER.

3. Similarly, pick the second request in the test case, and type sold in the Value cell for the status parameter. To confirm the change, hit ENTER:

4. We are now prepared to execute our test case. This will be done in the following step.
 

Run Functional Tests

You can execute requests, test cases, test suites, or the entire test project using Ready API.

It makes sense to run individual requests if you want to test how these requests function. You must run a test case that simulates numerous requests to simulate a user scenario. Multiple test cases can be run at once with the aid of test suites, and running a test project entails running every test suite associated with it.

Run individual requests

When writing tests, you typically run individual requests. So, you can quickly see the data from the response, alter the request parameters if necessary, or add assertions. Requests frequently rely on information from earlier test steps in complex tests. When you execute these requests separately, they will fail.

• To run an individual request test step, Click it  in the Navigator panel on the left, and then Select on the main toolbar or it on the request editor toolbar:

• The response's contents are visible in the right part of the request editor   

 

Run test cases

• To run a test case, Click it    in the Navigator panel and then click on the main or editor toolbar:

• Ready API will run each test step of the test case one by one. Results are displayed in the test case editor. Time information on the test execution is available on the Transaction Log page:

So, as you can see, the test case editor has pages like History, where you can view test run trends, or Compare, where you can compare two test logs that are not accessible at the test step level.

• Although our requests were successfully processed, the Transaction Log shows that no test steps were completed:

This happens because our test steps have no checkpoints.

Add Assertions to Functional Tests

Assertions are validation rules that are used on test results to evaluate the performance of your target web service. Assertions are used in Ready API Test tests to check response codes, response headers, specific values in response bodies, request execution time, and other things. After a test step (request) has finished, the test runner executes assertions.

Frequently Asked Questions

How do I run a functional test in Ready API?

To view the image larger, click it. Ready API will create a project, and a confirmation dialogue will appear. Click Run in the dialogue box to run the functional test you just created, or click Add Data to build a data-driven test that uses an Excel data source. Simply close the dialogue if you don't want to carry out any operations.

How do I create a functional test for an API?

If your company already uses an API, you can write a test for it. New Functional Test under File. Click Functional Test in the New Test tile on the Dashboard.Click Start after selecting the Ready API Project option in the New Functional Test. Wizard.

How do I test a SOAP service in Ready API?

Establish a functional test A WSDL definition of the SOAP service is required to test it in Ready API. This definition explains how the service operates and  how requests and responses are formatted. Ready API uses this data to simulate requests. Definitions may also be used for REST services.

Conclusion

In this article, we have extensively discussed the details of tutorials and samples for functional testing in Ready API,in which we create First Functional Test, Explore the Test project ,Modify Functional Test, run the functional tests for individual requests, run the test cases and add assertions to functional tests. 

We hope this blog has been beneficial to you. to enhance your knowledge regarding Tutorials and samples for Functional Testing in Ready API. You can go through these links if you're interested in learning more.

🔥 Functional Tests

🔥 Testing APIs

🔥 Ready API
 

You can refer to our guided paths on the Coding Ninjas Studio platform to learn more about DSA, DBMS, Competitive Programming, Python, Java, JavaScript, etc. To practice and improve yourself in the interview, you can also check out Top 100 SQL problems, Interview experience, Coding interview questions, and the Ultimate guide path for interviews. Do upvote our blog to help other ninjas grow. Enjoy the Coding!🤗