Wiremock query parameter JSON stub file

Question

I'm trying to mock query parameter using a wiremock JSON stub file.

It works when I do it this way :

{
  "request": {
    "method": "GET",
    "url": "/posts?id=1",
  },
//...
}

However when I change my query parameter to use the dedicated field like this it doesn't work anymore :

{
  "request": {
    "method": "GET",
    "urlPath": "/posts",
    "queryParameters": {
      "id": {
        "equalTo": "1"
      }
    }
  },
  //...
}

Any idea why ?

The test request looks like http://some-host/posts?id=1

Not really, I got an error saying "No further request expected", like when the mock is not called. I tried upgrading without result. I should try to produce a minimal reproductible exemple — Robert jardonneau, Aug 17 '18 at 15:22
are you doing it standalone? can you try http://localhost:8080/__admin? do you have this in mappings directory ? — Ryuzaki L, Aug 17 '18 at 15:26

score 14 · Answer 1 · answered Aug 14 '18 at 01:02

This works for me, change your "urlPath" to "urlPathPattern" but be careful in structuring this JSON. so urlPath is exact matching pattern, but urlPathPattern is regex matching on path and query parameter

  {
        "request": {
            "urlPathPattern": "/posts",
            "method": "GET",
            "queryParameters": {
                "id": {
                    "equalTo": "1"
                }
            }
        },
        "response": {
            "status": 200,
            "body":"This is successful"
        }
    }

Had the same issue. Changing it to urlPathPattern worked for me. Thank you. — Imran AK, Mar 30 '23 at 09:19

score 7 · Answer 2 · edited Aug 23 '18 at 09:24

You can try with urlPathPattern instead of urlPath.

As said by here urlPath which is for an exact match, and urlPathPattern is for regex.

So using urlPathPattern in QueryParameter your query get resolve.

{
  "request": {
    "method": "GET",
    "urlPathPattern": "/posts",
    "queryParameters": {
      "id": {
        "equalTo": "1"
      }
    }
  },
  //...
}

Try and understand below concept for Wiremock.

score 3 · Answer 3 · answered Aug 20 '18 at 04:39

3

The issue is that urlPath doesn't work with queryParameters and that this is simply expected behavior. :-/ I found this Q&A on the topic at the Wiremock Github repo. According to @tomakehurst's answer, this is expected behavior and queryParameters will match if you use urlPathPattern.

answered Aug 20 '18 at 04:39

entpnerd

10,049
8
47
68

The link you provided says urlPattern doesn't work with queryParameters, not urlPath – Nicko Jul 26 '22 at 11:49

Wiremock query parameter JSON stub file

3 Answers3