Test Console

Test Console consists of three main sections:

​

Request

​

Creating Request Address

There are two ways to create a request address:

• The endpoint to be tested can be written manually
• An API Proxy on Apinizer can be tested from the Test Helper interface or a request address can be created from an API definition file

​

Creating Request Address with Test Helper

When the selected button in the following image is clicked, the Test Helper dialog opens. The fields used for Test Helper configuration are shown in the table below.

​

Adding Query Parameter

Query parameters of the request are managed from the Parameters tab. Each edited value is automatically updated on the URL information.

​

Adding Header

Request headers are managed from the Headers tab.

​

Adding Body

Data to be added to the request body can be created in two different ways: raw, x-www-form-urlencoded

​

Format XML

Format XML operation can be performed with the data to be added to the request body.

​

Format JSON

Format JSON operation can be performed with the data to be added to the request body.

​

WS Security Sign

WS Security Sign operation can be performed when the data to be added to the request body is selected as raw. When the WS Security Signing button is pressed, the data in the test console is signed with the following configuration. The fields used for WS Security Sign configuration are shown in the table below.

​

Sign JSON

Sign JSON operation can be performed when the data to be added to the request body is selected as raw. When the JSON signing button is pressed, the data in the test console is signed with the following configuration. The fields used for Sign JSON configuration are shown in the table below.

​

Creating Assertion

The Assertion tab allows verification of the response related to the request by querying values in the body with timeout, HTTP status code, body, JsonPath/XPath and comparing with expected values. The fields used for Assertion configuration are shown in the table below.

​

Settings

Timeout and certificate information are managed in the Settings tab. The fields used for Settings configuration are shown in the table below.

​

Code Snippet

The Code Snippet tab enables generating the code necessary to send the request via cURL.

​

Creating New Test

If a new test is desired after a test operation is performed, the test field information can be refreshed by clicking the button marked in the following image.

​

Response

​

Response Body

The body of the response is shown in this section. Format XML and Format JSON operations can be performed with the response body data.

​

Request Response Headers

The headers of the response are shown in this section.

​

Assertion Results

Results about whether assertions added to the request were successful are shown in this tab.

​

Response Logs

The log of the response information is seen in this section.

​

History

The history of each request tested in the Test Console is stored. Test history is categorized by the days they were tested. When the link to the test’s log is clicked, the request can be tested again.

​

Test History Deletion Operations

• Click the Clear All link to delete all history information
• Delete day-based history from the detail menu of the relevant day information
• Delete only history from the detail menu of the relevant history information

​

Collection

Collection is the creation of test records configured under a group structure so that tests can be reused. Multiple collections can be found within each collection.

​

Saving Test to a Collection

After completing your test, click the Save button marked in the image to save it. Then, click the link of the collection to which the test will be assigned in the dialog named Collection List that opens. Apinizer creates a collection named ‘Default Collection’ for startup. After selecting your collection, the test is saved by giving it a name. The name of the default test record is determined as the endpoint URL information you tested.

​

Collection-Based Operations

Operations that can be performed on a collection are done through the detail menu of the collection in the following image. Rename: Used to change the name of the relevant collection. When clicked, a new name is given to the screen that appears and saved. Add New Collection: Used to add a new collection inside the relevant collection. Delete Collection: Used to delete the relevant collection. If a collection is deleted, all records connected to that collection will be deleted.

​

Record-Based Operations

Many operations that can be performed on a record are accessed through the detail menu in the following image. Rename: Used to change the name of the relevant test. When clicked, a new name is given to the screen that appears and saved. Duplicate: Used to create a copy of the relevant test. Create Monitor: Used to create an Uptime Monitor using the relevant test. Click the Uptime Monitor page for detailed information. Delete Test: Used to delete the relevant test. Save As: Click the button marked in the image to save a saved test to another collection.