starred/WireMock.Net
1
0
Fork 0
mirror of https://github.com/wiremock/WireMock.Net.git synced 2026-09-03 03:27:12 +02:00
Code Issues 32 Packages Projects Releases 10 Wiki Activity

Is there a way to record API calls in the file format required for WireMock Testcontainers? #594

New Issue
Closed
opened 2025-12-29 08:30:42 +01:00 by adam · 1 comment
adam commented 2025-12-29 08:30:42 +01:00
Owner
Copy Link
Copy Source

Originally created by @asos-alexhaigh on GitHub (Apr 30, 2024).

One feature of WireMock that I have always appreciated was the ability to generate the JSON files for Mocks by recording requests and responses from the real API. It removes human error and allows us to have full confidence that we are testing with the correct data.

I've just started using the WireMock test containers in a new project and it seems that it requires JSON in a different format which has required me to manually adjust the files to get it to work.

Is there a way to record files so I don't have to do this manual step?

This is how I am loading the mapping files

    private const string PATH_TO_MAPPINGS = @"my/path/toMappings";

    private readonly WireMockContainer _api= new WireMockContainerBuilder()
        .WithAutoRemove(autoRemove: true)
        .WithMappings(PATH_TO_MAPPINGS)
        .WithWatchStaticMappings(true)
        .WithCleanUp(cleanUp: true)
        .Build();
        
    public async Task StartAsync() => await _api.StartAsync();

An example of a recorded JSON file. This will not work when provided to a testcontainer.

{
  "id": "3ba83902-9666-4b24-8626-860396c0d14f",
  "name": "rest_v4_users",
  "request": {
    "url": "/rest/v4/users/?clientUserId=doesnotexist",
    "method": "GET"
  },
  "response": {
    "status": 204,
    "headers": {
      "Strict-Transport-Security": "max-age=15780000; includeSubDomains",
      "X-Rate-Limit": "7500",
      "X-Rate-Limit-Remaining": "7491",
      "X-Rate-Limit-Reset": "1714150451",
      "Set-Cookie": [ "JSESSIONIDSSO=123; Path=/; Secure; HttpOnly; SameSite=Lax", "JSESSIONIDSSO=123; Path=/; Secure; HttpOnly; SameSite=Lax", "TS01aeada2=123; Path=/; Secure; HTTPOnly" ],
      "X-ContextId": "123",
      "X-Server": "8.51",
      "Date": "Fri, 26 Apr 2024 16:47:07 GMT"
    }
  },
  "uuid": "3ba83902-9666-4b24-8626-860396c0d14f",
  "persistent": true,
  "insertionIndex": 14
}

My manual migration from to the above, to make it work with the test container.

{
  "Guid": "3ba83902-9666-4b24-8626-860396c0d14f",
  "UpdatedAt": "2024-04-26T17:21:13.6373664Z",
  "Request": {
    "Path": {
      "Matchers": [
        {
          "Name": "WildcardMatcher",
          "Pattern": "/v4/users",
          "IgnoreCase": true
        }
      ]
    },
    "Methods": [
      "GET"
    ],
    "Params": [
      {
        "Name": "clientUserId",
        "Matchers": [
          {
            "Name": "ExactMatcher",
            "Pattern": "doesnotexist"
          }
        ]
      }
    ]
  },
  "Response": {
    "StatusCode": 204
  }
}
Originally created by @asos-alexhaigh on GitHub (Apr 30, 2024). One feature of WireMock that I have always appreciated was the ability to generate the JSON files for Mocks by recording requests and responses from the real API. It removes human error and allows us to have full confidence that we are testing with the correct data. I've just started using the WireMock test containers in a new project and it seems that it requires JSON in a different format which has required me to manually adjust the files to get it to work. Is there a way to record files so I don't have to do this manual step? This is how I am loading the mapping files ``` c# private const string PATH_TO_MAPPINGS = @"my/path/toMappings"; private readonly WireMockContainer _api= new WireMockContainerBuilder() .WithAutoRemove(autoRemove: true) .WithMappings(PATH_TO_MAPPINGS) .WithWatchStaticMappings(true) .WithCleanUp(cleanUp: true) .Build(); public async Task StartAsync() => await _api.StartAsync(); ``` An example of a recorded JSON file. This will not work when provided to a testcontainer. ``` json { "id": "3ba83902-9666-4b24-8626-860396c0d14f", "name": "rest_v4_users", "request": { "url": "/rest/v4/users/?clientUserId=doesnotexist", "method": "GET" }, "response": { "status": 204, "headers": { "Strict-Transport-Security": "max-age=15780000; includeSubDomains", "X-Rate-Limit": "7500", "X-Rate-Limit-Remaining": "7491", "X-Rate-Limit-Reset": "1714150451", "Set-Cookie": [ "JSESSIONIDSSO=123; Path=/; Secure; HttpOnly; SameSite=Lax", "JSESSIONIDSSO=123; Path=/; Secure; HttpOnly; SameSite=Lax", "TS01aeada2=123; Path=/; Secure; HTTPOnly" ], "X-ContextId": "123", "X-Server": "8.51", "Date": "Fri, 26 Apr 2024 16:47:07 GMT" } }, "uuid": "3ba83902-9666-4b24-8626-860396c0d14f", "persistent": true, "insertionIndex": 14 } ``` My manual migration from to the above, to make it work with the test container. ``` json { "Guid": "3ba83902-9666-4b24-8626-860396c0d14f", "UpdatedAt": "2024-04-26T17:21:13.6373664Z", "Request": { "Path": { "Matchers": [ { "Name": "WildcardMatcher", "Pattern": "/v4/users", "IgnoreCase": true } ] }, "Methods": [ "GET" ], "Params": [ { "Name": "clientUserId", "Matchers": [ { "Name": "ExactMatcher", "Pattern": "doesnotexist" } ] } ] }, "Response": { "StatusCode": 204 } } ```
adam added the question label 2025-12-29 08:30:42 +01:00
adam closed this issue 2025-12-29 08:30:42 +01:00
adam commented 2025-12-29 08:30:43 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Apr 30, 2024):

The recorded JSON file seems to be from WireMock (Java version)

The manual migration JSON is the one that this project (WireMock.Net for .NET) uses.

Note that there should be some support in this project to support JSON files from WireMock.org (Java), bit I'm not sure if that still works.
See also https://github.com/WireMock-Net/WireMock.Net/wiki/WireMock.Org

@StefH commented on GitHub (Apr 30, 2024): The recorded JSON file seems to be from WireMock (Java version) The manual migration JSON is the one that this project (WireMock.Net for .NET) uses. Note that there should be some support in this project to support JSON files from WireMock.org (Java), bit I'm not sure if that still works. See also https://github.com/WireMock-Net/WireMock.Net/wiki/WireMock.Org
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
bug
doc
doc
duplicate
feature
feature
invalid
pull-request
Mirrored from GitHub Pull Request
 question
wontfix
No labels question
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/WireMock.Net#594