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

Updated Stubbing (markdown)

Stef Heyenrath
2018-08-31 18:14:05 +02:00
parent b427023471
commit c1bcc1108c
1 changed files with 0 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
Stubbing.md

@@ -41,128 +41,6 @@ server
); );
``` ```
## Response Templating
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.
Example:
```csharp
var server = FluentMockServer.Start();
server
.Given(
Request.Create().WithPath("/some/thing").UsingGet()
)
.RespondWith(
Response.Create()
.WithStatusCode(200)
.WithHeader("Content-Type", "text/plain")
.WithBody("Hello world! Your path is {{request.path}}.")
.WithTransformer()
);
```
### The request model
The model of the request is supplied to the header and body templates. The following request attributes are available:
* `request.url` - URL path and query
* `request.absoluteurl` - URL path and query (absolute)
* `request.path` - URL path
* `request.absolutepath` - URL path (absolute)
* `request.PathSegments.[<n>]` - URL path segment (zero indexed) e.g. request.PathSegments.[2]
* `request.AbsolutePathSegments.[<n>]` - URL absolute path segments (zero indexed) e.g. request.AbsolutePathSegments.[2]
* `request.query.<key>`- First value of a query parameter e.g. request.query.search
* `request.query.<key>.[<n>]`- nth value of a query parameter (zero indexed) e.g. request.query.search.[5]
* `request.headers.<key>` - First value of a request header e.g. request.headers.X-Request-Id
* `request.headers.[<key>]` - Header with awkward characters e.g. request.headers.[$?blah]
* `request.headers.<key>.[<n>]` - nth value of a header (zero indexed) e.g. request.headers.ManyThings.[1]
* `request.cookies.<key>` - Value of a request cookie e.g. request.cookies.JSESSIONID
* `request.body` - Request body text as string
* `request.bodyAsJson` - Request body as dynamic Json Object. Note that the request **must** contain the header `Content-Type` with value `application/json`!
### Handlebars helpers
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}}`
### JsonPath support
JsonPath support is also present (internal logic is based on Newtonsoft.Json).
Two functions are present:
1. JsonPath.SelectToken
2. JsonPath.SelectTokens
#### JsonPath.SelectToken
This can be used in C# like:
```csharp
var server = FluentMockServer.Start();
server
.Given(Request.Create().WithPath("/jsonpathtestToken").UsingPost())
.RespondWith(Response.Create()
.WithHeader("Content-Type", "application/json")
.WithBody("{{JsonPath.SelectToken request.body \"$.Manufacturers[?(@.Name == 'Acme Co')]\"}}")
.WithTransformer()
);
```
Or using the admin mapping file:
``` js
{
"Request": {
"Path": {
"Matchers": [
{
"Name": "WildcardMatcher",
"Pattern": "/jsonpathtestToken"
}
]
},
"Methods": [
"post"
]
},
"Response": {
"StatusCode": 200,
"BodyDestination": "SameAsSource",
"Body": "{{JsonPath.SelectToken request.body \"$.Manufacturers[?(@.Name == 'Acme Co')]\"}}",
"UseTransformer": true,
"Headers": {
"Content-Type": "application/json"
}
}
}
```
Note that also replacing values in a Json Object and returning a the body as Json is supported, to use this, use a mapping file like this:
``` js
{
"Request": {
"Path": {
"Matchers": [
{
"Name": "WildcardMatcher",
"Pattern": "/test"
}
]
},
"Methods": [
"post"
]
},
"Response": {
"StatusCode": 200,
"BodyAsJson": {
"path": "{{request.path}}",
"result": "{{JsonPath.SelectToken request.bodyAsJson \"username\"}}"
},
"UseTransformer": true,
"Headers": {
"Content-Type": "application/json"
}
}
}
```
## Stub priority ## Stub priority
It is sometimes the case that you’ll want to declare two or more stub mappings that "overlap", in that a given request would be a match for more than one of them. It is sometimes the case that you’ll want to declare two or more stub mappings that "overlap", in that a given request would be a match for more than one of them.