Skip to content

Document transformer registration for dynamic ports #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Chandu0501 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document transformer registration for dynamic ports #420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/content/docs/docs/extensibility/transforming-responses.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,37 @@ public static class ExampleTransformer implements ResponseDefinitionTransformerV
Transformer classes must have a no-args constructor unless you only
intend to register them via an instance as described below.

### Registering the transformer

To use the transformer, register it when you create the `WireMockServer`.
If you are using a dynamic port, either use the instance DSL from the server itself
or configure the static DSL after the server has started:

```java
WireMockServer wireMockServer = new WireMockServer(
wireMockConfig()
.dynamicPort()
.extensions(new ExampleTransformer()));

wireMockServer.start();

// Use the instance DSL directly with the dynamically assigned port.
wireMockServer.stubFor(get(urlEqualTo("/transform"))
.willReturn(aResponse()
.withBody("Original body")
.withTransformers("example")));

// Or configure the static DSL after startup if you prefer to use stubFor(...).
WireMock.configureFor("localhost", wireMockServer.port());
stubFor(get(urlEqualTo("/transform"))
.willReturn(aResponse()
.withBody("Original body")
.withTransformers("example")));
```

See [Extending WireMock](../extending-wiremock/) for the other registration options,
including class-name registration and standalone usage.

### Supplying parameters

Parameters are supplied on a per stub mapping basis:
Expand Down