Introduction

Welcome to HammerUI documentation. This page destribes basic and advanced features that are available in our application.
First of all, HammerUI has 2 main modes

  • UI mode (default)
  • command line mode
The same executable file is being used in both modes.

Main features

This is the main screen of the application:


UI elements:
  1. Menu bar
  2. Top bar with frequently used buttons
  3. Environments and proxy settings
  4. Project tree
  5. Request view


Application settings

Application settings are accessible from Menu bar via Settings -> Application Settings


Available settings:
  • Auto-save project at exit - user project will be automatically saved when application is closing
  • Open last project at startip - automatically open previously opened project at startup
  • User-Agent - default user agent string used by HammerUI
  • Application Theme - UI theme of the application. Can be either "Dark" or "Light"
  • Editor Theme - Request/Response editor theme. Multiple themes are available

Project settings

Project settings are accessible from Menu bar via Settings -> Project Settings


Available settings:
  • follow HTTP 301 redirections - automatically follow "Location" header from the response
  • connection timeout - default connection timeout (in milliseconds)
  • socket read timeout - default socket read timeout (in milliseconds)
  • ignore SSL certificate errors - ignore any issues related to invalid SSL certificates
  • use TCP no delay - disable Nagle's algorithm

Menu bar is located at the top of the application screen:

Menu bar contains follow groups of options:
  • File
    • Add new request - add new request to the project
    • Add new folder - add new folder to the project
    • New Project - create new project
    • Open - open existing project file
    • Open Recent - open one of the previous project files
    • Save - save current project file
    • Save As... - save project as new file
    • Close - close application
  • Language
    • English - switch to english UI language
    • Polish - switch to polish UI language
    • Chinese - switch to chinese UI language
  • Settings
    • Application Settings - open application settings window
    • Project Settings - open project settings window
  • View
    • Hide/Show project tree - hide or show project tree
    • Hide/Show request details - hide or show request details panel
    • Show horizontal/vertical view - switch between horizontal and vertical view of the request/response panel
    • Close all tabs - close all open tabs
    • Close active tab - close currently open tab
    • Close other tabs - close all tabs except currently open
    • Close tabs on right - close all tabs on the right side of current tab
  • Help
    • Executor log - open HTTP request/response low level debug console
    • About - open window with version and license details

Top bar

Top bar is located just under Menu bar and above project tree:

Top bar contains following buttons:
  1. Add new request
  2. Add new folder
  3. Show/Hide project tree
  4. Switch between horizontal and vertical view

Project Tree

Project tree contains all requests and folders associated with current HammerUI project file.


Default features of project tree view includes adding new project (first button) and adding new folder (second button).
Project tree also allows moving items around the tree (using drag-and-drop).
Each item has context menu available on the right side when mouse is moved over the item.

Context menu for request contains:
  • Rename - rename item
  • Delete - delete item
  • Clone - clone item
  • Export as CURL - export request using CURL command
Context menu for folder contains:
  • Add Request - add new request inside selected folder
  • Add Folder - add new subfolder inside selected folder
  • Rename - rename item
  • Delete - delete item
  • Clone - clone item

Request view

Project tree contains all requests and folders associated with current HammerUI project file.


Request view has 4 main parts:
  1. request tabs - currently open requests
  2. URL textfield - text field with URL and also a dropdown list all requests in current project.
    Dropdown list is sorted by the time of execution starting from most recent one
  3. request details - request details like headers, authentication, payload
  4. response details - response headers, payload, HTTP code, response time, response size, tests

Tests

There are 23 different test types that can be added to each response.


Here is a list of available tests:
  • jsonpath exists
  • jsonpath does not exist
  • jsonpath contains
  • jsonpath contains ignore case
  • jsonpath does not contain
  • jsonpath count equal
  • jsonpath count less than
  • jsonpath count greater than
  • jsonpath value equal
  • response contains
  • response contains (ignore case)
  • response does not contain
  • response does not contain (ignore case)
  • header exists
  • header does not exist
  • header contains
  • header does not contain
  • status code between
  • status code not between
  • status code equal
  • status code different than
  • response time less than
  • response time greater than

Environments and variables

Environments settings allow customer to have a set of variables that are being replace at execution time based on selected environment.


This allows the same request e.g. to be execution against different hostnames, in case hostname is a parameter.
HammerUI is replacing parameters with their values in one of the following places:

  • URL
  • headers (both header name and header value)
  • request payload (including form data)
With parameters above, request http://192.168.0.38:8080/endpoint/json1 can be parametrized
as http://{server}:{port}/endpoint/json1


Proxy

HammerUI allows user to configure default proxy settings for making requests.


Debug View

HammerUI has a build in debug view, that shows low level debug messages provided by Apache Http Client


Each time request is executed, debug view (also called execution log) will show log messages related to the latest execution.
This view contains low level details that may be helpful during debugging/troubleshooting.
Debug view is accessible from Main bar via Help -> Execution log


To export logs into a file, please use Save As button

License

In order to view license details, or to load license file, please go to Help -> About

To close About window, please hit Escape key or click "X" button.


To load license, click Load License button and select license file. Details will show up automatically.

CLI

HammerUI second mode of execution is CLI. In order to enter CLI mode, type: HammerUI.exe cli