Show List
Tutorials > Wiremock > Returning predefined responses

Returning predefined responses

Creating a basic mock server using WireMock is a simple process, and once you have your mock server up and running, you can configure it to return predefined responses for incoming HTTP requests. Here's a step-by-step guide to creating a basic mock server and configuring it to return predefined responses:

  • First, download and install WireMock. You can download the standalone JAR file from the official website: http://wiremock.org/.

  • Once you have WireMock installed, create a new directory where you will store your mock server configuration files. This directory will contain a JSON file that defines the mappings between HTTP requests and responses.

  • Inside your configuration directory, create a new file called mappings.json. This file will contain the mappings for the mock HTTP services you want to create.

  • Define the mappings inside the mappings.json file using JSON syntax. For example:

json
Copy code
{
  "request": {
    "method": "GET",
    "url": "/greeting"
  },
  "response": {
    "status": 200,
    "body": "Hello, World!"
  }
}

This example defines a mapping for a GET request to the URL /greeting. The response to this request will have a status code of 200 and a body containing the string "Hello, World!".

  • Start the WireMock server by running the following command from the directory where you extracted the WireMock files:
css
Copy code
java -jar wiremock-standalone-{version}.jar --port 8080 --root-dir {path/to/your/configuration/directory}

Replace {version} and {path/to/your/configuration/directory} with the appropriate values for your system.

  • Test your mock server by sending a GET request to http://localhost:8080/greeting. You should receive a response with a status code of 200 and a body containing the string "Hello, World!".

  • You can create additional mappings for your mock server by adding more entries to the mappings.json file. For example, you could define a mapping for a POST request to the URL /submit:

json
Copy code
{
  "request": {
    "method": "POST",
    "url": "/submit",
    "bodyPatterns": [
      {
        "equalTo": "username=john&password=secret"
      }
    ]
  },
  "response": {
    "status": 200,
    "body": "OK"
  }
}

This mapping defines a POST request to the URL /submit with a body that contains the string "username=john&password=secret". The response to this request will have a status code of 200 and a body containing the string "OK".

By creating mappings like these, you can create a mock server that behaves exactly the way you want it to, and that can be used to test and develop your applications without relying on external APIs or services.



Next: Advanced configuration of Wiremock

    Leave a Comment

  • captcha text