Extends WireMock with a graphical user interface
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 to the flat list view.
If mappings are stored on a drive in different directories, this structure will be extracted and mappings metadata will be updated automatically, so that wiremock-gui can show the same folder structure.
You can also update mapping metadata to create a structure manually. 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 the gui:
While editing a mapping you can add the metadata structure for a folde via "general functions" -> "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. A badge indicates if the selected mapping answered the request. If this is the case the following is shown:
If another mapping answered the request a link to the mapping, which answered the request is shown:
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
Name | Parameter | Description |
---|---|---|
JWT | algo | Signing algorithm. Check jsonwebtoken for SignatureAlgorithm. E.g. RS256 |
key | Base64 encoded key to use. Kind of key depends on used algo | |
claims | a json string which describes the claims to use. Must not be null in case no payload is defined | |
payload | a json string which contains the content of the jwt. Must not be null in case no claims are defined | |
header | a json string which contains the header to use |
The docker images are based on the official wiremock images now. Therefore, check the official guide regarding configuration etc. The docker compose example below is alread updated.
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"
command:
"--port 8089 --https-port 8088 --max-request-journal 1000 --local-response-templating"
volumes:
- ./root-dir:/home/wiremock
environment:
WIREMOCK_MY_VAR: "systemValue response templating feature"
In the past only alpine images existed. New versioning concept is:
holomekc/wiremock-gui:{version} or holomekc/wiremock-gui:latest
holomekc/wiremock-gui:{version}-alpine or holomekc/wiremock-gui:latest-alpine
In case you want to use this Docker image on an Apple Mac with M1 or M2 processor you cannot use the alpine image. The docker images are based on the official wiremock docker images. I only replace the wiremock jar file in the image. The official wiremock docker images use eclipse-temurin as base image for the alpine and none alpine version. Sadly the alpine version of temurin does not support arm yet. See: https://github.com/adoptium/containers/issues/158. Theoretically, I could switch to a different base image, but this would create increased maintenance. I hope temurin is updated soon-ish. Please use the none alpine version on a Mac for the time being.