Python
Python
-
+
Spring Boot
diff --git a/_docs/jetty-12.md b/_docs/jetty-12.md
new file mode 100644
index 00000000..91769fe8
--- /dev/null
+++ b/_docs/jetty-12.md
@@ -0,0 +1,62 @@
+---
+layout: docs
+title: "Using WireMock with Jetty 12"
+meta_title: Using WireMock with Jetty 12 | WireMock
+description: WireMock ships with Jetty 11 by default but fully supports Jetty 12 as well.
+---
+
+WireMock ships with Jetty 11 by default but fully supports Jetty 12 as well with a new module `wiremock-jetty12`. In this tutorial we are going to see how Wiremock could be configured to use Jetty 12.
+
+## Prerequisites
+
+- Java 17
+- Maven or Gradle, recent versions
+- A Java project, based on Maven or Gradle
+
+## Add WireMock Dependency to your project
+
+{% codetabs %}
+
+{% codetab Maven %}
+
+```xml
+
diff --git a/_docs/solutions/dotnet.md b/_docs/solutions/dotnet.md
index 81ac805e..a332c58c 100644
--- a/_docs/solutions/dotnet.md
+++ b/_docs/solutions/dotnet.md
@@ -6,6 +6,7 @@ description: "Additional solutions for WireMock when using .NET"
logo: /images/logos/technology/dotnet.svg
---
+
## WireMock.Net
diff --git a/_docs/solutions/golang.md b/_docs/solutions/golang.md
index 5e2b8c5a..78454888 100644
--- a/_docs/solutions/golang.md
+++ b/_docs/solutions/golang.md
@@ -10,6 +10,8 @@ redirect_from:
hide-disclaimer: true
---
+
+
## Testcontainers module for Go
The WireMock community provides a [Testcontainers for Go module](https://github.com/wiremock/wiremock-testcontainers-go) module
diff --git a/_docs/solutions/graphql.md b/_docs/solutions/graphql.md
index 24b0f91e..49698b7f 100644
--- a/_docs/solutions/graphql.md
+++ b/_docs/solutions/graphql.md
@@ -11,6 +11,8 @@ redirect_from:
hide-disclaimer: true
---
+
+
## WireMock Extension
There is a [GraphQL extension for WireMock](https://github.com/wiremock/wiremock-graphql-extension)
diff --git a/_docs/solutions/groovy.md b/_docs/solutions/groovy.md
index 400f251c..11d3134d 100644
--- a/_docs/solutions/groovy.md
+++ b/_docs/solutions/groovy.md
@@ -6,6 +6,8 @@ description: "Additional solutions for WireMock when using Groovy"
logo: /images/logos/technology/groovy.svg
---
+
+
## DSL Bindings
There is a [Groovy DSL binding library](https://github.com/tomjankes/wiremock-groovy)
diff --git a/_docs/solutions/jvm.md b/_docs/solutions/jvm.md
index ff6c06d9..d647848b 100644
--- a/_docs/solutions/jvm.md
+++ b/_docs/solutions/jvm.md
@@ -7,6 +7,8 @@ logo: /images/logos/technology/java.svg
hide-disclaimer: true
---
+
+
WireMock was originally created for Java development,
and there are plenty of solutions when developing applications powered by the Java Virtual Machine.
@@ -64,5 +66,6 @@ sorted by alphabet:
- [Clojure](https://docs.google.com/document/d/1TQccT9Bk-o2lvRVN8_mMaGttaOnwbYFLkn0DsmwGIOA/edit#heading=h.gvb3rxc1ab9p)
- [Groovy](../groovy)
- [Kotlin](../kotlin)
+- [Pact](../pact)
- [Scala](https://docs.google.com/document/d/1TQccT9Bk-o2lvRVN8_mMaGttaOnwbYFLkn0DsmwGIOA/edit#heading=h.gvb3rxc1ab9p)
- [Spring Boot](../spring-boot)
diff --git a/_docs/solutions/kotlin.md b/_docs/solutions/kotlin.md
index 322b90d8..1fdb38bb 100644
--- a/_docs/solutions/kotlin.md
+++ b/_docs/solutions/kotlin.md
@@ -6,6 +6,7 @@ description: Additional solutions for WireMock when using Kotlin
logo: /images/logos/technology/kotlin.svg
---
+
## Kotlin DSL Bindings
diff --git a/_docs/solutions/kubernetes.md b/_docs/solutions/kubernetes.md
index 5e22728b..47bb695a 100644
--- a/_docs/solutions/kubernetes.md
+++ b/_docs/solutions/kubernetes.md
@@ -7,6 +7,8 @@ logo: /images/logos/technology/kubernetes.svg
hide-disclaimer: true
---
+
+
## WireMock Helm Chart (Experimental)
There is an [experimental Helm Chart](https://wiremock.github.io/helm-charts/) for WireMock.
diff --git a/_docs/solutions/nodejs.md b/_docs/solutions/nodejs.md
index 47f9f867..1d8a6c9b 100644
--- a/_docs/solutions/nodejs.md
+++ b/_docs/solutions/nodejs.md
@@ -6,6 +6,8 @@ description: Additional solutions for WireMock when using Node.js
logo: /images/logos/technology/nodejs.svg
---
+
+
## WireMock Captain
WireMock Captain provides an easy interface for testing HTTP-based APIs.
@@ -61,3 +63,11 @@ console.log(stubMappings);
await wireMock.global.shutdown();
```
+
+## WireMock NPM package
+
+The WireMock NPM package is the WireMock standalone JAR packaged inside an NPM package. It has the exact same features as WireMock standalone and uses the same versioning.
+
+The main benefit of packaging it inside an NPM package is that the user will only need access to an NPM registry to use it. This is often the situation when working behind firewalls in organizations.
+
+- [GitHUb Repository](https://github.com/wiremock/wiremock-npm)
diff --git a/_docs/solutions/pact.md b/_docs/solutions/pact.md
new file mode 100644
index 00000000..9ef7935d
--- /dev/null
+++ b/_docs/solutions/pact.md
@@ -0,0 +1,176 @@
+---
+layout: solution
+title: "Using WireMock with Pact"
+meta_title: Running WireMock with Pact | WireMock
+description: The recorded invocations on WireMock can be used to generate the JSON files that are needed to publish contracts to the Pactflow broker.
+redirect_from:
+- "/docs/pact.html"
+---
+
+## WireMock Pact
+
+WireMock Pact will get the requests from [WireMock](https://github.com/wiremock/wiremock/) and create [Pact JSON](https://docs.pact.io/) files on the filesystem. The Pact JSON can be published to a [Pactflow broker](https://test.pactflow.io/).
+
+WireMock Pact contains:
+
+- `wiremock-pact-lib` - *A library that can transform WireMock [ServeEvent](https://github.com/wiremock/wiremock/blob/master/src/main/java/com/github/tomakehurst/wiremock/stubbing/ServeEvent.java):s to Pact JSON.*
+- `wiremock-pact-extension-junit5` - *A WireMock extension, and JUnit 5, that is intended to ease usage of the library.*
+- `wiremock-pact-example-springboot-app` - *A SpringBoot application that shows how it can be used.*
+
+WireMock Pact is released to [Maven Central](https://central.sonatype.com/search?q=se.bjurr.wiremockpact). And [available on GitHub](https://github.com/wiremock/wiremock-pact).
+
+## Usage - Junit 5
+
+The extension is both a WireMock extension and a JUnit 5 extension. When using [`wiremock-spring-boot`](https://wiremock.org/docs/solutions/spring-boot/) it can be configured like this in a base class of your tests:
+
+```java
+import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
+import com.maciejwalkowiak.wiremock.spring.ConfigureWireMock;
+import com.maciejwalkowiak.wiremock.spring.EnableWireMock;
+import com.maciejwalkowiak.wiremock.spring.WireMockConfigurationCustomizer;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import se.bjurr.wiremockpact.wiremockpactextensionjunit5.WireMockPactExtension;
+import se.bjurr.wiremockpact.wiremockpactlib.api.WireMockPactConfig;
+
+@EnableWireMock({
+ @ConfigureWireMock(
+ name = "wiremock-service-name",
+ property = "wiremock.server.url",
+ stubLocation = "wiremock",
+ configurationCustomizers = {WireMockPactBaseTest.class})
+})
+public class WireMockPactBaseTest implements WireMockConfigurationCustomizer {
+ @RegisterExtension
+ static WireMockPactExtension WIREMOCK_PACT_EXTENSION =
+ new WireMockPactExtension(
+ WireMockPactConfig.builder() //
+ .setConsumerDefaultValue("WireMockPactExample") //
+ .setProviderDefaultValue("UnknownProvider") //
+ .setPactJsonFolder("src/test/resources/pact-json"));
+
+ @Override
+ public void customize(
+ final WireMockConfiguration configuration, final ConfigureWireMock options) {
+ configuration.extensions(WIREMOCK_PACT_EXTENSION);
+ }
+}
+```
+
+### Usage - Library
+
+It can be used as a library.
+
+```java
+public class ExampleTest {
+ private static WireMockServer server;
+ private static WireMockPactApi wireMockPactApi;
+
+ @BeforeAll
+ public static void beforeEach() throws IOException {
+ server = new WireMockServer();
+ server.start();
+
+ stubFor(
+ post(anyUrl())
+ .willReturn(
+ ok()
+ .withHeader("content-type", "application/json")
+ .withBody("""
+ {"a":"b"}
+ """))
+ .withMetadata(
+ new Metadata(
+ Map.of(
+ WireMockPactMetadata.METADATA_ATTR,
+ new WireMockPactMetadata()
+ .setProvider("some-specific-provider")))));
+
+ wireMockPactApi =
+ WireMockPactApi.create(
+ new WireMockPactConfig()
+ .setConsumerDefaultValue("my-service")
+ .setProviderDefaultValue("unknown-service")
+ .setPactJsonFolder("the/pact-json/folder"));
+ wireMockPactApi.clearAllSaved();
+ }
+
+ @Test
+ public void testInvoke() {
+ // Do stuff that invokes WireMock...
+ }
+
+ @AfterAll
+ public static void after() {
+ for (final ServeEvent serveEvent : server.getAllServeEvents()) {
+ wireMockPactApi.addServeEvent(serveEvent);
+ }
+ // Save pact-json to folder given in WireMockPactApi
+ wireMockPactApi.saveAll();
+ server.stop();
+ }
+}
+```
+
+### Mappings metadata - Set provider in mapping
+
+You can adjust any mappings file like this to specify the provider of a mapping in its [metadata](https://github.com/wiremock/spec/blob/main/wiremock/wiremock-admin-api/schemas/stub-mapping.yaml) field:
+
+```diff
+{
+ "id" : "d68fb4e2-48ed-40d2-bc73-0a18f54f3ece",
+ "request" : {
+ "urlPattern" : "/animals/1",
+ "method" : "GET"
+ },
+ "response" : {
+ "status" : 202
+ },
+ "uuid" : "d68fb4e2-48ed-40d2-bc73-0a18f54f3ece",
++ "metadata": {
++ "wireMockPactSettings": {
++ "provider":"some-other-system"
++ }
++ }
+}
+```
+
+Or programmatically:
+
+```java
+ stubFor(
+ post(anyUrl())
+ .withMetadata(
+ new Metadata(
+ Map.of(
+ WireMockPactMetadata.METADATA_ATTR,
+ new WireMockPactMetadata()
+ .setProvider("some-specific-provider")))));
+```
+
+### Publishing to Pact broker
+
+Pact has a [CLI tool](https://docs.pact.io/pact_broker/publishing_and_retrieving_pacts) that can be used for publishing the contracts. But it requires Ruby or Docker. If you don't have that, perhaps `curl` is an option. There is [a shell script here](https://github.com/tomasbjerre/pactflow-publish-sh) that can also be used [via NPM](https://www.npmjs.com/package/pactflow-publish-sh).
+
+You may want to use something like [git-changelog-command-line](https://github.com/tomasbjerre/git-changelog-command-line) to get the next version.
+
+There is a test-server at https://test.pactflow.io/ that can be accessed with user `dXfltyFMgNOFZAxr8io9wJ37iUpY42M` and password `O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1`.
+
+```sh
+current_version=$(npx git-changelog-command-line \
+ --patch-version-pattern "^fix.*" \
+ --print-current-version)
+git_hash=`git rev-parse --short HEAD`
+participant_version_number="$current_version-$git_hash"
+
+npx pactflow-publish-sh \
+ --username=dXfltyFMgNOFZAxr8io9wJ37iUpY42M \
+ --password=O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1 \
+ --pactflow-broker-url=https://test.pactflow.io/contracts/publish \
+ --build-url=http://whatever/ \
+ --pact-json-folder=wiremock-pact-example-springboot-app/src/test/resources/pact-json \
+ --participant-version-number=$participant_version_number
+```
+
+## Useful pages
+
+- [WireMock on Java and JVM](../jvm) - Most of JVM generic solutions are applicable to Spring Boot development too
diff --git a/_docs/solutions/python.md b/_docs/solutions/python.md
index 8f4f2f93..a57ce433 100644
--- a/_docs/solutions/python.md
+++ b/_docs/solutions/python.md
@@ -7,6 +7,7 @@ logo: /images/logos/technology/python.svg
hide-disclaimer: true
---
+
## Python WireMock
diff --git a/_docs/solutions/quarkus.md b/_docs/solutions/quarkus.md
index eb642a3d..b4360e88 100644
--- a/_docs/solutions/quarkus.md
+++ b/_docs/solutions/quarkus.md
@@ -6,6 +6,7 @@ description: "Additional solutions for WireMock when developing with Quarkus"
logo: /images/logos/technology/quarkus.svg
---
+
## WireMock Extension for Quarkus
diff --git a/_docs/solutions/rust.md b/_docs/solutions/rust.md
index 150db781..a2bceffc 100644
--- a/_docs/solutions/rust.md
+++ b/_docs/solutions/rust.md
@@ -6,6 +6,8 @@ description: "Additional solutions for WireMock when using Rust"
logo: /images/logos/technology/rust.svg
---
+
+
## wiremock-rs. Server implementation in Rust
[LukeMathWalker/wiremock-rs](https://github.com/LukeMathWalker/wiremock-rs) is an API Mock Server implementation in Rust.
diff --git a/_docs/solutions/spring-boot-integration.md b/_docs/solutions/spring-boot-integration.md
new file mode 100644
index 00000000..cb32f0d5
--- /dev/null
+++ b/_docs/solutions/spring-boot-integration.md
@@ -0,0 +1,42 @@
+---
+layout: solution
+title: "Using WireMock with Spring Boot"
+meta_title: Running WireMock with Spring Boot | WireMock
+description: The team behind Spring Cloud Contract have created a library to support running WireMock using the “ambient” HTTP server
+redirect_from:
+- "/docs/solutions/spring-boot.html"
+- "/docs/solutions/spring-boot/"
+logo: /images/logos/technology/spring.svg
+hide-disclaimer: true
+---
+
+
+
+## WireMock Spring Boot
+
+WireMock's official Spring Boot integration library is the simplest way to configure Spring Boot, Junit 5 and WireMock to work together.
+
+
+It includes fully declarative WireMock setup, supports multiple `WireMockServer` instances, automatically sets Spring environment properties,
+and does not pollute Spring application context with extra beans.
+
+See [WireMock Spring Boot Integration](/docs/spring-boot/) for details on installation and usage.
+
+You can contribute or log an issue in the [GitHub project](https://github.com/wiremock/wiremock-spring-boot).
+
+## Spring Cloud Contract
+
+WireMock provides the mocking capabilities for the Spring Cloud Contract project (a consumer-driven contract testing tool).
+
+See [Spring Cloud Contract WireMock](https://docs.spring.io/spring-cloud-contract/docs/current/reference/html/project-features.html#features-wiremock) for details.
+
+## Jetty version issues when running WireMock and Spring together.
+
+WireMock's main artifact is built on Jetty 11, largely so that Java 11 support can be maintained. However, many Spring applications depend on Jetty 12 and the presence of both on the classpath causes WireMock to fail with a `ClassNotFoundException` or `NoClassDefFoundError` for Servlet API classes thrown during startup.
+
+To rectify this, WireMock now has a dedicated Jetty 12 artifact which can be added to your project's classpath. See the [Jetty 12 page](../../jetty-12/) for details.
+
+
+## Useful pages
+
+- [WireMock on Java and JVM](../jvm) - Most of JVM generic solutions are applicable to Spring Boot development too
diff --git a/_docs/solutions/spring-boot.md b/_docs/solutions/spring-boot.md
deleted file mode 100644
index bb27b622..00000000
--- a/_docs/solutions/spring-boot.md
+++ /dev/null
@@ -1,64 +0,0 @@
----
-layout: solution
-title: "Using WireMock with Spring Boot"
-meta_title: Running WireMock with Spring Boot | WireMock
-toc_rank: 116
-description: The team behind Spring Cloud Contract have created a library to support running WireMock using the “ambient” HTTP server
-redirect_from:
-- "/docs/spring-boot.html"
-logo: /images/logos/technology/spring.svg
----
-
-## WireMock Spring Boot
-
-[WireMock Spring Boot](https://github.com/maciejwalkowiak/wiremock-spring-boot)
-simplifies testing HTTP clients in Spring Boot & Junit 5 based integration tests.
-It includes fully declarative WireMock setup,
-supports multiple `WireMockServer` instances,
-automatically sets Spring environment properties,
-and does not pollute Spring application context with extra beans.
-
-Example:
-
-```java
-@SpringBootTest
-@EnableWireMock({
- @ConfigureWireMock(name = "user-service", property = "user-client.url")
-})
-class TodoControllerTests {
-
- @InjectWireMock("user-service")
- private WireMockServer wiremock;
-
- @Autowired
- private Environment env;
-
- @Test
- void aTest() {
- // returns a URL to WireMockServer instance
- env.getProperty("user-client.url");
- wiremock.stubFor(stubFor(get("/todolist").willReturn(aResponse()
- .withHeader("Content-Type", "application/json")
- .withBody("""
- [
- { "id": 1, "userId": 1, "title": "my todo" },
- ]
- """)
- )));
- }
-}
-```
-
-## Spring Cloud Contract
-
-The team behind Spring Cloud Contract have created a library to support running WireMock using the "ambient" HTTP server.
-It also simplifies some aspects of configuration and eliminates some common issues that occur when running Spring Boot and WireMock together.
-
-See [Spring Cloud Contract WireMock](https://docs.spring.io/spring-cloud-contract/docs/current/reference/html/project-features.html#features-wiremock) for details.
-
-The article [Faking OAuth2 Single Sign-on in Spring](https://engineering.pivotal.io/post/faking_oauth_sso/)
-from Pivotal's blog shows how WireMock can be used to test Spring apps that use 3rd party OAuth2 login.
-
-## Useful pages
-
-- [WireMock on Java and JVM](../solutions/jvm) - Most of JVM generic solutions are applicable to Spring Boot development too
diff --git a/_docs/solutions/testcontainers.md b/_docs/solutions/testcontainers.md
index c1d5f83b..0925f66d 100644
--- a/_docs/solutions/testcontainers.md
+++ b/_docs/solutions/testcontainers.md
@@ -12,6 +12,8 @@ redirect_from:
- "/testcontainers/"
---
+
+
The WireMock community provides modules for [Testcontainers](https://testcontainers.com/).
They allow provisioning the WireMock server as a standalone container within your tests,
based on [WireMock Docker](https://github.com/wiremock/wiremock-docker).
diff --git a/_docs/spring-boot.md b/_docs/spring-boot.md
new file mode 100644
index 00000000..e524a460
--- /dev/null
+++ b/_docs/spring-boot.md
@@ -0,0 +1,237 @@
+---
+layout: docs
+title: "WireMock Spring Boot Integration"
+meta_title: Using WireMock's Spring Boot + JUnit 5 integration | WireMock
+description: Integrating WireMock, Spring Boot and JUnit 5 via the official integration library.
+---
+
+WireMock's Spring Boot integration provides a simple, declarative way to configure and run one or more WireMock instances their JUnit tests.
+
+## Installation
+
+Maven:
+```xml
+
+ 
+ 
+ 
+ 
+ 
+ Add the following to your project's pom.xml dependencies:
+{% highlight xml %} +Then follow the next steps for JUnit 5+ or plain Java.
+Add the following to your project's build.gradle:
+{% highlight groovy %} +testImplementation "org.wiremock:wiremock:{{ site.wiremock_4_version }}" +{% endhighlight %} +Then follow the next steps for JUnit 5+ or plain Java.
+Add the following to your project's build.gradle.kts:
+{% highlight kotlin %} +testImplementation("org.wiremock:wiremock:{{ site.wiremock_4_version }}") +{% endhighlight %} +Then follow the next steps for JUnit 5+ or plain Java.
+Add the following to your project’s build.sbt:
+{% highlight scala %} +libraryDependencies += + "org.wiremock" % "wiremock" % "{{ site.wiremock_version }}" % Test +{% endhighlight %} ++ Download the latest standalone JAR + then run the following in a terminal: +
+{% highlight bash %} +java -jar wiremock-standalone-{{ site.wiremock_4_version }}.jar +{% endhighlight %} +Learn more in the running standalone guide.
+