starred/WireMock.Net
1
0
Fork 0
mirror of https://github.com/wiremock/WireMock.Net.git synced 2026-04-23 17:28:55 +02:00
Code Issues 32 Packages Projects Releases 10 Wiki Activity

Updated Response Templating (markdown)

Stef Heyenrath
2019-12-06 12:44:04 +01:00
parent 7c09296e71
commit 33e127a231
1 changed files with 31 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
Response-Templating.md

@@ -2,7 +2,7 @@
Response headers and bodies can optionally be rendered using [Handlebars.Net](https://github.com/rexm/Handlebars.Net) templates. Response headers and bodies can optionally be rendered using [Handlebars.Net](https://github.com/rexm/Handlebars.Net) templates.
This enables attributes of the request to be used in generating the response e.g. to pass the value of a request ID header as a response header or render an identifier from part of the URL in the response body. To use this functionality, add `.WithTransformer()` to the response builder. This enables attributes of the request to be used in generating the response e.g. to pass the value of a request ID header as a response header or render an identifier from part of the URL in the response body. To use this functionality, add `.WithTransformer()` to the response builder.
Example: C# Example:
```csharp ```csharp
var server = FluentMockServer.Start(); var server = FluentMockServer.Start();
server server
@@ -11,13 +11,36 @@ server
) )
.RespondWith( .RespondWith(
Response.Create() Response.Create()
.WithStatusCode(200)
.WithHeader("Content-Type", "text/plain")
.WithBody("Hello world! Your path is {{request.path}}.") .WithBody("Hello world! Your path is {{request.path}}.")
.WithTransformer() .WithTransformer()
); );
``` ```
Mapping Json Example:
``` js
{
"Guid": "fd8ca21b-db82-48bc-ae5a-fc2153c2b0db",
"Request": {
"Path": {
"Matchers": [
{
"Name": "WildcardMatcher",
"Pattern": "/bodyasfile_transform123"
}
]
},
"Methods": [
"get"
]
},
"Response": {
"Headers": { "Content-Type": "application/xml" },
"BodyAsFile": "c:\\temp-wiremock\\__admin\\mappings\\_{{request.query.MyUniqueNumber}}_\\MyXmlResponse.xml",
"UseTransformer": true
}
}
```
### The request model ### The request model
The model of the request is supplied to the header and body templates. The following request attributes are available: The model of the request is supplied to the header and body templates. The following request attributes are available:
@@ -40,6 +63,11 @@ The model of the request is supplied to the header and body templates. The follo
All of the standard helpers (template functions) provided by the C# Handlebars implementation plus all of the string helpers are available e.g. All of the standard helpers (template functions) provided by the C# Handlebars implementation plus all of the string helpers are available e.g.
`{{capitalize request.query.search}}` `{{capitalize request.query.search}}`
### Transform the content from a referenced file
By default, only the response (headers, statuscode, body) are transformed when the `.WithTransformer()` or `UseTransformer` are defined.
In case you also want to transform the contents from a referenced file (via `BodyAsFile`), an additional parameter need to added. Like `.WithTransformer(bool)` or `UseTransformerForBodyAsFile = true`.
### Generate Random Data Support ### Generate Random Data Support
It's possible to return random data using the `Random` Handlebars function. It's possible to return random data using the `Random` Handlebars function.