Quick Start


Download the latest API Test Base release and unpack it. The created folder will be referred to as <APITestBase_Home> hereafter.

Alternatively, you can also build API Test Base by yourself.

Prerequisite: Java 1.8+

Install JRE (Java SE Runtime Environment) or JDK 1.8+ if it is not already on your machine.

For example, if you want to install OpenJDK 12 on Windows, here is a quick tutorial.

To verify Java is on your machine, just open a command line window and run

java -version

You should see something like

openjdk version "12.0.2" 2019-07-16
OpenJDK Runtime Environment (build 12.0.2+10)
OpenJDK 64-Bit Server VM (build 12.0.2+10, mixed mode, sharing)


Open a command line window, cd to <APITestBase_Home> and run below command

java -Djava.net.useSystemProxies=true -jar apitestbase-<version>.jar server config.yml

On Windows, alternatively you can simply run <APITestBase_Home>\start.bat.

Once the application is successfully launched, there will be a log like below displayed in the command line output

API Test Base started with UI address http://localhost:8090/ui

Open a web browser (Google Chrome preferred), and go to the UI address.

Ad Hoc Invocation

If you only want to invoke an API and see its response, just need to create a test step in a new or existing test case.

To create a new test case, right click on a folder in the tree, select Create Test Case and give it a name.

New Ad Hoc Test Case

Suppose you want to invoke a REST API. On the right pane of the screen, i.e. the test case edit view, under the Test Steps tab, click Create dropdown button and select HTTP Step. The test step edit view opens.

Under the Basic Info tab, set the test step name. Under the Invocation tab, select Method like GET, set URL like http://localhost:8090/api/articles (an API Test Base bundled API) and click Invoke button.

Ad Hoc HTTP Invocation