WireMock

https://github.com/wiremock/wiremock
Admin
WireMock is a flexible, open-source tool for HTTP-based API mocking that enables developers to...
Tokens:8,430
Snippets:92
Trust Score:9.8
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Apply code formatting with Spotless

Source: https://github.com/wiremock/wiremock/blob/master/CONTRIBUTING.md

Automatically fixes formatting failures to comply with the Google Java style guide using the Gradle Spotless plugin.

```bash
./gradlew spotlessApply
```

--------------------------------

### Generate breaking-change report with Claude Code

Source: https://github.com/wiremock/wiremock/blob/master/README.md

Run this command if you have Claude Code installed to generate a filtered summary of binary-incompatible changes.

```text
/breaking-change-report
```

--------------------------------

### WireMock Recorder JavaScript Logic

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/recorder/index.html

JavaScript functions for managing recording status, starting and stopping recording sessions, and updating the UI based on API responses.

```javascript
function showMessage(message) { $('#validationMessage') .removeClass('showError') .addClass('showMessage') .text(message); } function showError(message) { $('#validationMessage') .removeClass('showMessage') .addClass('showError') .text(message); } function hideMessage() { $('#validationMessage').removeClass('showError'); } $(function() { const base = window.location.href.startsWith('file') ? 'http://localhost:8080' : ''; $.getJSON(base + '/__admin/recordings/status', function(data) { if (data.status === 'Recording') { $('#stopRecording').attr('disabled', false); showMessage('Recording...'); } else { $('#startRecording').attr('disabled', false); } }); $('#startRecording').click(function(event) { const baseUrl = $('#targetBaseUrl').val(); if (baseUrl == null || baseUrl.length === 0) { showError('You need to enter a valid target URL.'); return; } else { hideMessage(); } event.target.disabled = true; $.ajax({ method: "POST", url: base + '/__admin/recordings/start', crossDomain: true, mimeType: 'application/json', data: JSON.stringify({ targetBaseUrl: baseUrl }), dataType: 'json' }).done(function() { $('#stopRecording').attr('disabled', false); showMessage('Recording...'); }); }); $('#stopRecording').click(function(event) { event.target.disabled = true; $.ajax({ method: 'POST', crossDomain: true, url: base + '/__admin/recordings/stop' }).done(function(data) { const count = data.mappings.length; showMessage('Captured ' + count + ' stub mappings.'); $('#startRecording').attr('disabled', false); }); }); });
```

--------------------------------

### Disable Scarf analytics in package.json

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/swagger-ui/swagger-ui-dist/README.md

Set the scarfSettings.enabled field to false in your project's package.json to opt out of anonymized installation analytics.

```json
// package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}
```

--------------------------------

### Run all tests with Gradle

Source: https://github.com/wiremock/wiremock/blob/master/CONTRIBUTING.md

Executes the full test suite for the WireMock project.

```bash
./gradlew check
```

--------------------------------

### Build thin and standalone JARs

Source: https://github.com/wiremock/wiremock/blob/master/CONTRIBUTING.md

Compiles the project and generates both thin and standalone JAR files, which are placed in the build/libs directory.

```bash
./gradlew jar shadowJar
```

--------------------------------

### Import SwaggerUIBundle and SwaggerUIStandalonePreset

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/swagger-ui/swagger-ui-dist/README.md

Import the core Swagger UI components from the swagger-ui-dist package.

```javascript
  import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"
```

--------------------------------

### Generate raw breaking-change report with Gradle

Source: https://github.com/wiremock/wiremock/blob/master/README.md

Run this command to generate the raw report including all public classes, not just those annotated with @PublishedAPI.

```bash
./gradlew :wiremock-core:japicmp
```

--------------------------------

### Swagger UI JavaScript Initialization

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/swagger-ui/index.html

JavaScript function to initialize the SwaggerUIBundle with the WireMock Admin API documentation URL.

```javascript
window.onload = function() { // Begin Swagger UI call region const ui = SwaggerUIBundle({ url: "/__admin/docs/swagger", dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], layout: "StandaloneLayout" }); // End Swagger UI call region window.ui = ui; };
```

--------------------------------

### Publish JARs to local Maven repository

Source: https://github.com/wiremock/wiremock/blob/master/CONTRIBUTING.md

Publishes the generated JAR files to the local Maven repository.

```bash
./gradlew publishToMavenLocal
```

--------------------------------

### Bump minor version using Gradle

Source: https://github.com/wiremock/wiremock/blob/master/RELEASING.md

Use this command to increment the minor version of the project.

```bash
./gradlew bump-minor-version
```

--------------------------------

### Retrieve absolute path for static file serving

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/swagger-ui/swagger-ui-dist/README.md

Use the getAbsoluteFSPath method to obtain the absolute path to the directory for serving static files.

```javascript
const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()

// then instantiate server that serves files from the swaggerUiAssetPath
```

--------------------------------

### Bump patch version using Gradle

Source: https://github.com/wiremock/wiremock/blob/master/RELEASING.md

Use this command to increment the patch version of the project.

```bash
./gradlew bump-patch-version
```

--------------------------------

### Swagger UI CSS Configuration

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/swagger-ui/index.html

CSS styles for the Swagger UI container to ensure proper box-sizing and scroll behavior.

```css
html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; } *, *:before, *:after { box-sizing: inherit; } body { margin:0; background: #fafafa; }
```

--------------------------------

### Normalize a Host component

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Parses a host string and normalizes it to RFC 3986 standards.

```java
Host host = Host.parse("EXAMPLE.COM%2fpath");
Host normalised = host.normalise();  // Returns "example.com%2Fpath"
```

--------------------------------

### Standard Parsing Interface

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

All types in the library provide this standard static method for parsing string representations.

```java
static Type parse(String stringForm);
```

--------------------------------

### WireMock Recorder CSS Styles

Source: https://github.com/wiremock/wiremock/blob/master/src/main/resources/assets/recorder/index.html

CSS definitions for the WireMock Recorder interface, including layout, button styling, and validation message states.

```css
body { font-family: sans-serif; } h1 { margin-bottom: 3rem; color: #6C7692; } #logo { height: 40px; width: auto; display: inline; vertical-align: text-bottom; padding-bottom: 0.2rem; } .content { margin: auto; width: 600px; /*height: 300px;*/ padding-top: 100px; vertical-align: middle; } .ca-cert-box { border: 1px solid black; padding: 1em; vertical-align: middle; margin-top: 80px; color: #898989; font-size: 90%; } .ca-cert-box a { color: #42407d; } .ca-cert-box a:visited { color: #42407d; } button { background-color: #1D2539; padding: 10px; color: white; font-size: 1.5rem; border-radius: 5px; border: none; margin-right: 1rem; } button:disabled { background-color: #AAA; } input { border-radius: 5px; } #targetBaseUrlLabel { color: #777; font-size: 1.2rem; } #targetBaseUrl { height: 1.5rem; width: 32rem; display: block; margin-top: 0.3rem; margin-bottom: 1rem; border: 2px solid grey; padding: 5px; } #validationMessage { margin-bottom: 3rem; border: none; color: transparent; width: 32rem; padding: 6px; } .showError { border: 1px solid red !important; color: red !important; } .showMessage { border: 1px solid darkgreen !important; color: darkgreen !important; }
```

--------------------------------

### Parse a URL string

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Parses a string into a type-safe Url object.

```java
Url url = Url.parse("https://example.com/path?query=value#fragment");
```

--------------------------------

### Normalization Idempotence Invariant

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Ensures that applying the normalise method multiple times results in the same state.

```java
instance.normalise().equals(instance.normalise().normalise()) == true;
```

--------------------------------

### Decode a Fragment component

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Parses a fragment string and decodes percent-encoded characters.

```java
Fragment fragment = Fragment.parse("section%20name");
String decoded = fragment.decode();  // Returns "section name"
```

--------------------------------

### Parse Idempotence Invariant

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Ensures that parsing and converting back to a string preserves the original input.

```java
Type.parse(input).toString().equals(input) == true;
```

--------------------------------

### Round-Trip Equality Invariant

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Ensures that parsing a URI string and converting it back preserves equality, with noted exceptions for specific path structures.

```java
Uri.parse(uri.toString()).equals(uri) == true;
```

--------------------------------

### PercentEncoded Encoding Interface

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Types that implement the PercentEncoded interface provide this static method for encoding unencoded strings.

```java
static Type encode(String unencoded);
```

--------------------------------

### Percent-Encoded Round-Trip Invariants

Source: https://github.com/wiremock/wiremock/blob/master/wiremock-url/wiremock-url/README.md

Defines two invariants for percent-encoded values regarding encoding, decoding, and normalization cycles.

```java
PercentEncoded encoded = PercentEncoded.encode(original);
encoded.decode().equals(original) == true;
```

```java
PercentEncoded normalisedEncoded = PercentEncoded.parse(originalEncoded).normalise();
String decoded = normalisedEncoded.decode();
PercentEncoded reEncoded = PercentEncoded.encode(decoded);
reEncoded.equals(normalisedEncoded) == true;
```
Tokens:
Raw