Extends WireMock with a graphical user interface

• Mappings
  • A paginated list or folder view of all mappings
  • Search for mappings
  • Add / Edit / Remove new mappings
  • Add templates directly into mapping (Response Templating, Proxying, etc.)
  • Save / Reset / Remove all mappings
  • Reset all scenarios
  • Separated view improve readability
  • Test mapping
    • Allows to quickly test the mapping by sending http requests.
• Matched
  • A paginated list of all requests which could be handled by Wiremock
  • Copy cUrl
  • Reset Journal
• Unmatched
  • A paginated list of all requests which could not be handled by Wiremock
  • Copy cUrl
  • Copy request to clipboard for new mapping creation
  • Copy SOAP to clipboard which understands not matched SOAP requests and help during creation
  • Reset Journal
• StateMachine (experimental)
  • A paginated list of all mappings which are part of a scenario
  • States are calculated automatically
  • Mappings are represented as links
  • Button on links allows to show mapping details
• Record/playback of stubs
  • Help to start recording or snapshot
• Auto refresh when mappings or requests changes

The gui is part of the Wiremock admin interface. Therefore, just open the following URL:

<Wiremock baseUrl>/__admin/webapp

Since 2.32.0.2

For mappings the folder view is selected by default. It is still possible to switch easier list view as well.

If mappings are stored on a drive in different directories this structure will be extracted and mappings metadata will be updated so that wiremock-gui can show the same folder structure.

You can also manually update mapping metadata to create a structure. This helps if you do not store mappings but load them via http, or if you do not want to place the file in different directories.

metadata structure:

{
     "metadata": {
          "wiremock-gui": {
               "folder": "/some/folder"
          }
     }
}

will create following structure in gui:

In general functions when editing a mapping you can add the metadata structure via "add Folder".

drag-and-drop into folders is currently not supported. It is a more complex topic, as it is currently not possible to sort mappings.

There is a branch on which drag-and-drop is implemented. So if you are interested you can test it there. Due to the mentioned not supported sorting mappings might jump to a different location after reloading.

Since 2.32.0.2

Allows testing of mappings via an HTTP request. This feature tries to extract url and content-type from mapping information. The prefilled data highly depends on how the request in the mapping is defined.

When executing the request the response is shown and also a badge which indicates if the selected mapping answered the request. If this is the case the following is shown:

If another mapping answered the request no match is shown and a link to the mapping which answered the request:

Keep in mind this feature will never be as powerful as tools like Postman, Insomnia, etc. So the overall idea is to provide a quick way to test if your mapping is properly setup.

Custom Handlebars helpers

Wiremock parameters can be passed via the environment variable WIREMOCK_OPTIONS. The values need to be of the following form:

--<param>,--<param>

Deprecated use new Configuration options

Wiremock parameters can be passed via environment variables. They need to start with WIREMOCK_ and then the wanted wiremock option. E.g. WIREMOCK_PORT.

A short example of a compose file

version: "3"
services:
  wiremock:
    image: "holomekc/wiremock-gui:latest"
    container_name: my_wiremock
    ports:
      # This is just an example of a port mapping
      - "8088:8089"
      - "8084:8088"
    environment:
      WIREMOCK_PORT: 8089
      WIREMOCK_HTTPS_PORT: 8088
      WIREMOCK_MAX_REQUEST_JOURNAL: 1000
      WIREMOCK_LOCAL_RESPONSE_TEMPLATING: 
      WIREMOCK_ROOT_DIR: /home/wiremock/storage

Mappings

Separated View

StateMachine

Test

Test Response