Applies to ReadyAPI 3.4, last modified on October 26, 2020

About

You use VirtServer to run virtual services in your network. (Virtual service or virtual API is a virtualized representation of a web service. See ReadyAPI Virtualization Introduction.)

VirtServer is tightly integrated with ReadyAPI Virtualization. It runs virtual services created with ReadyAPI Virtualization, and it is managed from within ReadyAPI.

You can run VirtServer on any supported operating system: Windows, Linux, or macOS. It does not have a GUI and can run on headless machines, as well.

Required Licenses

To work with VirtServer, you need a ReadyAPI Virtualization Pro license. If you do not have it, request it on our web site.

Also, VirtServer requires its own license in addition to the ReadyAPI Virtualization Pro license.

How VirtServer Works

You install and launch VirtServer on some computer in your network (typically, this is a server that is available 24x7).

You then create virtual services in ReadyAPI by defining operations and responses in the editor, or by discovering operations from the recorded traffic, or in any other supported manner.

When your virtual service is ready for testing, you deploy (that is, upload) it to VirtServer and start it there. You can then run tests against this virtual service as you normally do this for other APIs:

API testing with ReadyAPI: How VirtServer works

If you do not have a virtual service, you can download it from VirtServer to your computer for editing, change it in your ReadyAPI (for instance, add a new operation) and then re-deploy back to VirtServer. See Editing Deployed Virtual Services.

You control virtual services and VirtServers in the VirtServer panel of ReadyAPI:

API testing with ReadyAPI: The VirtServer panels

Click the image to enlarge it.

Notes:

  • You can use several VirtServers in your network. Each VirtServer requires a license.

  • Each VirtServer can run one or multiple virtual services. The number of allowed concurrent virtual services is controlled by your VirtServer license.

  • VirtServer uses the HTTPS protocol and port 9090 to exchange data with ReadyAPI. The port number is configurable.

  • The VirtServer version should match the version of ReadyAPI. We recommend using the same version of both, VirtServer and ReadyAPI.

    To connect to VirtServer 3.1 and later using ReadyAPI, you need ReadyAPI 1.6 or later. Older versions won't be able to connect because they use a now-deprecated authorization method.
    You cannot connect to VirtServer 3.0 and later by using ReadyAPI 2.8 or earlier if VirtServer’s compatibility mode is turned off. Update your ReadyAPI installation or turn the mode on.
  • Virtual services on VirtServer can work through the HTTP or HTTPS protocol and use any port that is not allocated by other processes running on the VirtServer computer.

  • For security reasons, you need to specify a user name and password to connect to VirtServer. You create a user when running VirtServer for the first time. You can also add more users at any time later.

Why Using VirtServer?

  • It helps you easily share your virtual services with your teammates for testing.

  • It frees you from running virtual services for testing. Having a virtual service running on VirtServer enables you to continue working on the virtual service locally on your computer.

  • With VirtServer, you can organize the processes of test creation and running better. This is especially useful in companies that run lots of tests on different APIs or different versions of the same API.

Where Do I Start?

See Also

Installation & Licensing VirtServer
User Tasks
Admin Tasks
VirtServer Panel of ReadyAPI
ReadyAPI Virtualization

Highlight search results