/tc-guide-testing-rest-api-integrations-using-wiremock

Testing REST API integrations using WireMock Guide

Primary LanguageJavaMIT LicenseMIT

Testing REST API integrations using WireMock

This is sample code for Testing REST API integrations using WireMock guide.

1. Setup Environment

Make sure you have Java 8+ and a compatible Docker environment installed. If you are going to use Maven build tool then make sure Java 17+ is installed.

For example:

$ java -version
openjdk version "17.0.4" 2022-07-19
OpenJDK Runtime Environment Temurin-17.0.4+8 (build 17.0.4+8)
OpenJDK 64-Bit Server VM Temurin-17.0.4+8 (build 17.0.4+8, mixed mode, sharing)
$ docker version
...
Server: Docker Desktop 4.12.0 (85629)
 Engine:
  Version:          20.10.17
  API version:      1.41 (minimum version 1.12)
  Go version:       go1.17.11
...

2. Setup Project

  • Clone the repository
git clone https://github.com/testcontainers/tc-guide-testing-rest-api-integrations-using-wiremock.git
cd tc-guide-testing-rest-api-integrations-using-wiremock
  • Open the tc-guide-testing-rest-api-integrations-using-wiremock project in your favorite IDE.

3. Run Tests

Run the command to run the tests.

$ ./gradlew test //for Gradle
$ ./mvnw verify  //for Maven

The tests should pass.

Note

The project is configured to automate the code formatting with spotless plugin using prettier-plugin-java, which internally requires Node.js runtime. If you don't have Node.js installed and want to disable the code formatting, you can pass additional parameter to the build command as shown below:

./gradlew build -x spotlessCheck //for Gradle
./mvnw verify -Dspotless.check.skip=true //for Maven