A proposal for some additional fluent build methods

[StefH]

Currently the C# code to build a request with a response is like:

server
    .Given(Request.Create()
        .WithPath("/mypath")
        .UsingPost()
    )
    
    .WithGuid("86984b0e-2516-4935-a2ef-b45bf4820d7d")
    
    .RespondWith(Response.Create()
        .WithHeader("Content-Type", "application/json")
        .WithBodyAsJson("{{JsonPath.SelectToken request.body \"..name\"}}")
        .WithTransformer()
    );

I want to make this a bit easier to use.

1️⃣

My first proposal is like this:

server
    .WithRequest(r => r //⚡ The Request.Create() has been replaced by an Action
        .WithPath("/mypath")
        .UsingPost()
    )
    
    .DefineGuid("86984b0e-2516-4935-a2ef-b45bf4820d7d") //⚡ An extra method DefineGuid is added
    
    .RespondWith(r => r //⚡ The Response.Create() has been replaced by an Action
        .WithHeader("Content-Type", "application/json")
        .WithBodyAsJson("{{JsonPath.SelectToken request.body \"..name\"}}")
        .WithTransformer()
    );

2️⃣

Optionally, my second proposal could be to use WhenRequest, so:

server
    .WhenRequest(r => r //⚡ The Request.Create() has been replaced by an Action
        .WithPath("/mypath")
        .UsingPost()
    )
    
    .DefineGuid("86984b0e-2516-4935-a2ef-b45bf4820d7d") //⚡ An extra method DefineGuid is added
    
    .RespondWith(r => r //⚡ The Response.Create() has been replaced by an Action
        .WithHeader("Content-Type", "application/json")
        .WithBodyAsJson("{{JsonPath.SelectToken request.body \"..name\"}}")
        .WithTransformer()
    );

3️⃣

Optionally, option 3, RespondWith is replaced by Respond:

server
    .WhenRequest(r => r //⚡ The Request.Create() has been replaced by an Action
        .WithPath("/mypath")
        .UsingPost()
    )
    
    .DefineGuid("86984b0e-2516-4935-a2ef-b45bf4820d7d") //⚡ An extra method DefineGuid is added
    
    .Respond(r => r //⚡ The Response.Create() has been replaced by an Action
        .WithHeader("Content-Type", "application/json")
        .WithBodyAsJson("{{JsonPath.SelectToken request.body \"..name\"}}")
        .WithTransformer()
    );

Also another change would be that in case you just want a simple 200 ok response, you can now use:

server
    .WithRequest(r => r
        .UsingGet()
    )
    .RespondWithOK();

or

server
    .WithRequest(r => r
        .UsingGet()
    )
    .RespondWithStatusCode(300);

(#1042)

[StefH]

Tagging:
@cezarypiatek
@robertmircea
@MindaugasLaganeckas
@MJLHThomassenHadrian
@mark-hingston
@basdijkstra
@jflevesque-genetec
@sameena-ops
@leolplex
@alastairtree
@NoahLerner
@phillee007
@vitaliydavydiak
@akamud
@kashifsoofi
@ggradnig
@eli-darkly
@cal-schleupen
@oleg-nenashev

[leolplex]

The option 2 reveals the intention, I'm inclined for second.

[jflevesque-genetec]

I follow @basdijkstra of having ThenRespondWith to follow the Given/When/Then format.

[StefH]

My vote goes to option 2 as well, with the suggestion to add alias methods ThenRespondWith() and similar to make it almost read like Gherkin.

Are you planning to create utility methods for all common status codes? Or just for RespondWithOk()? Because that would clutter the API in my opinion, I’d rather see you just offer RespondWithStatusCode() in that case.

My intent is only to define RespondWithOk() as convenience method.

[cal-schleupen]

I also follow @basdijkstra of having ThenRespondWith to follow the Given/When/Then format. Thus, Option 2 ;-)

[MJLHThomassenHadrian]

I concur that the phrasing of option 2 conveys intent the best.

[jflevesque-genetec]

What is the DefineGuid used for?

[StefH]

What is the DefineGuid used for?

It's the same as WithGuid.

This is used to assign a Guid to a mapping. If this is not defined WireMock will assign a random Guid.

[StefH]

Final version option 2️⃣

server
    .WhenRequest(r => r //⚡ The Request.Create() has been replaced by an Action
        .WithPath("/mypath")
        .UsingPost()
    )

    .DefineGuid("86984b0e-2516-4935-a2ef-b45bf4820d7d") //⚡ An extra method DefineGuid is added

    .ThenRespondWith(r => r //⚡ The Response.Create() has been replaced by an Action
        .WithHeader("Content-Type", "application/json")
        .WithBodyAsJson("{{JsonPath.SelectToken request.body \"..name\"}}")
        .WithTransformer()
        .WithStatusCode(HttpStatusCode.Accepted)
    );