Working With APIs

Applies to ReadyAPI 3.51, last modified on March 21, 2024

The APIs node in ReadyAPI shows all web services (or APIs) your projects use. Under this node, you can see your REST, GraphQL, Kafka, SOAP, and XML-RPC APIs, configure them, and perform tests on the spot.

What you can do with APIs

On the spot testing

You can send requests to your APIs without adding the former to a test case.

  1. Add the API to your project.

  2. Open the request editor.

  3. Click .

    Testing APIs in ReadyAPI: On the spot testing

    Click the image to enlarge it.

ReadyAPI will send the request, get the response from the server, and display it in the request editor. Use this editor to configure request parameters not specified in the definition you imported.

ReadyAPI offers a wide range of possible configurations of your requests. For information on this, see Configuring Requests.

If you try to run the request without an endpoint specified, ReadyAPI will warn you and suggest entering the endpoint to use.

Improve your API tests

After you import the API, it will be ready for testing immediately. You can send requests to your service and get responses. For more complex testing, ReadyAPI includes the following:

  • ReadyAPI Test helps you to create functional tests to make sure your service works as expected. You can create both simple and complex functional tests with data-driven loops, property expansions, scripting, and other convenient tools.

    Security tests help you to make sure your service can resist most common attacks. They provide both the preset scans and the scans you set up yourself.

  • ReadyAPI Performance simulates a massive load on the server. You can use various testing strategies to test different aspects of your server.

  • ReadyAPI Virtualization and VirtServer help you to create a virtual service to run your tests regardless of the development state of the API. It allows you to create complex behavior and simulate real behavior. With VirtServer, you can run your virtual services in the company network.

See Also

Working with Projects
Configuring Requests

Highlight search results