--- title: "render a response or forward template against a sample request without creating an expectation" method: PUT path: "/mockserver/template/test" tags: ["troubleshooting"] --- # render a response or forward template against a sample request without creating an expectation `PUT /mockserver/template/test` ## Request - Base URL: `http://localhost:1080` - URL: `http://localhost:1080/mockserver/template/test` - Auth: none declared Dry run of a Velocity, Mustache or JavaScript template. Renders the template against the sample request with the same engines, sandbox settings and JavaScript and Velocity timeouts as serving, and reports the rendered response (or request, for a forward template), or the failure with the template line and column where the engine reports one and a hint for common mistakes. A Velocity reference or Mustache variable that did not resolve, and a scenario.set call, are reported as warnings; a dry run never changes scenario state and writes nothing to the event log. When javascriptTemplateExecutionTimeout or velocityTemplateExecutionTimeout is 0 a dry run still stops that template after 5 seconds. At most two dry runs run at once and further calls get a 429; a Mustache template, or a Velocity template inside one long Java call, cannot be stopped, so the response is written after the time limit plus a grace period even if the template is still running. Running a template needs a role that may change expectations. ## Request body - object - `templateType` 'VELOCITY' | 'MUSTACHE' | 'JAVASCRIPT', required - `template` string, required: the template, as it would appear in an httpResponseTemplate or httpForwardTemplate - `actionType` 'RESPONSE_TEMPLATE' | 'FORWARD_TEMPLATE': whether the template renders a response or the request to forward - `request` HttpRequest: request properties matcher - `secure` boolean - `keepAlive` boolean - `method` union: string value that can be support nottable, optional or a json schema - string - object - `not` boolean - `optional` boolean - `value` string - `schema` Schema (unresolved $ref) - `parameterStyle` 'SIMPLE' | 'SIMPLE_EXPLODED' | 'LABEL' | 'LABEL_EXPLODED' | 'MATRIX' | 'MATRIX_EXPLODED' | 'FORM_EXPLODED' | 'FORM' | 'SPACE_DELIMITED_EXPLODED' | 'SPACE_DELIMITED' | 'PIPE_DELIMITED_EXPLODED' | 'PIPE_DELIMITED' | 'DEEP_OBJECT' - `path` union: string value that can be support nottable, optional or a json schema - string - object - `not` boolean - `optional` boolean - `value` string - `schema` Schema (unresolved $ref) - `parameterStyle` 'SIMPLE' | 'SIMPLE_EXPLODED' | 'LABEL' | 'LABEL_EXPLODED' | 'MATRIX' | 'MATRIX_EXPLODED' | 'FORM_EXPLODED' | 'FORM' | 'SPACE_DELIMITED_EXPLODED' | 'SPACE_DELIMITED' | 'PIPE_DELIMITED_EXPLODED' | 'PIPE_DELIMITED' | 'DEEP_OBJECT' - `pathParameters` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - `queryStringParameters` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - `body` union: request body matcher - object: binary body matcher - `not` boolean - `type` 'BINARY' - `base64Bytes` string - `contentType` string - object: json body matcher - `not` boolean - `type` 'JSON' - `json` string - `contentType` string - `matchType` 'STRICT' | 'ONLY_MATCHING_FIELDS' - `matchNumbersAsStrings` boolean - object: json matching fields body matcher - object: json schema body matcher - `not` boolean - `type` 'JSON_SCHEMA' - `jsonSchema` Schema (unresolved $ref) - object: JSON path body matcher - `not` boolean - `type` 'JSON_PATH' - `jsonPath` string - object: parameter body matcher - `not` boolean - `type` 'PARAMETERS' - `parameters` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - object: regex body matcher - `not` boolean - `type` 'REGEX' - `regex` string - object: string body matcher - `not` boolean - `type` 'STRING' - `string` string - `contentType` string - `subString` boolean - string: substring body matcher - object: xml body matcher - `not` boolean - `type` 'XML' - `xml` string - `contentType` string - object: xml schema body matcher - `not` boolean - `type` 'XML_SCHEMA' - `xmlSchema` string - object: xpath body matcher - `not` boolean - `type` 'XPATH' - `xpath` string - object: all-of body matcher — matches only when every one of its component body matchers matches the same request body - `not` boolean - `optional` boolean - `type` 'ALL_OF' - `bodyAllOf` Body[], required - object: binary body matcher - `not` boolean - `optional` boolean - `type` 'BINARY' - `base64Bytes` string - `contentType` string - object: json body matcher - `not` boolean - `optional` boolean - `type` 'JSON' - `json` string - `contentType` string - `matchType` 'STRICT' | 'ONLY_MATCHING_FIELDS' - `matchNumbersAsStrings` boolean - object: json schema body matcher - `not` boolean - `optional` boolean - `type` 'JSON_SCHEMA' - `jsonSchema` Schema (unresolved $ref) - object: JSON path body matcher - `not` boolean - `optional` boolean - `type` 'JSON_PATH' - `jsonPath` string - object: parameter body matcher - `not` boolean - `optional` boolean - `type` 'PARAMETERS' - `parameters` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - object: multipart form-data body matcher - `not` boolean - `optional` boolean - `type` 'MULTIPART' - `fields` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - `filenames` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - `partContentTypes` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - object: regex body matcher - `not` boolean - `optional` boolean - `type` 'REGEX' - `regex` string - object: string body matcher - `not` boolean - `optional` boolean - `type` 'STRING' - `string` string - `contentType` string - `subString` boolean - object: xml body matcher - `not` boolean - `optional` boolean - `type` 'XML' - `xml` string - `contentType` string - object: xml schema body matcher - `not` boolean - `optional` boolean - `type` 'XML_SCHEMA' - `xmlSchema` string - object: xpath body matcher - `not` boolean - `optional` boolean - `type` 'XPATH' - `xpath` string - object: JSON-RPC body matcher - `not` boolean - `optional` boolean - `type` 'JSON_RPC' - `method` string - `paramsSchema` string - object: GraphQL body matcher - `not` boolean - `optional` boolean - `type` 'GRAPHQL', required - `query` string, required - `operationName` string - `variablesSchema` string - `headers` union - object[] - `name` string - `values` string[] - object - `keyMatchStyle` 'MATCHING_KEY' | 'SUB_SET' - `cookies` union - object[] - `name` string - `value` string - object - `socketAddress` SocketAddress: remote address to send request to, only used for request overrides - `host` string - `port` integer - `scheme` 'HTTP' | 'HTTPS' - `protocol` 'HTTP_1_1' | 'HTTP_2' | 'HTTP_3': protocol matcher - `jwt` Jwt: JSON Web Token (JWT) request matcher — decodes the token carried in a request header (no signature verification) and matches its claims - `header` string: name of the request header carrying the JWT (default 'authorization') - `scheme` string: authentication scheme prefix stripped from the header value before decoding (default 'Bearer') - `claims` object: claim-value criteria; each value may be an exact string, regex or '!'-negated form - `issuer` union: string value that can be support nottable, optional or a json schema - string - object - `not` boolean - `optional` boolean - `value` string - `schema` Schema (unresolved $ref) - `parameterStyle` 'SIMPLE' | 'SIMPLE_EXPLODED' | 'LABEL' | 'LABEL_EXPLODED' | 'MATRIX' | 'MATRIX_EXPLODED' | 'FORM_EXPLODED' | 'FORM' | 'SPACE_DELIMITED_EXPLODED' | 'SPACE_DELIMITED' | 'PIPE_DELIMITED_EXPLODED' | 'PIPE_DELIMITED' | 'DEEP_OBJECT' - `audience` union: string value that can be support nottable, optional or a json schema - string - object - `not` boolean - `optional` boolean - `value` string - `schema` Schema (unresolved $ref) - `parameterStyle` 'SIMPLE' | 'SIMPLE_EXPLODED' | 'LABEL' | 'LABEL_EXPLODED' | 'MATRIX' | 'MATRIX_EXPLODED' | 'FORM_EXPLODED' | 'FORM' | 'SPACE_DELIMITED_EXPLODED' | 'SPACE_DELIMITED' | 'PIPE_DELIMITED_EXPLODED' | 'PIPE_DELIMITED' | 'DEEP_OBJECT' - `algorithm` union: string value that can be support nottable, optional or a json schema - string - object - `not` boolean - `optional` boolean - `value` string - `schema` Schema (unresolved $ref) - `parameterStyle` 'SIMPLE' | 'SIMPLE_EXPLODED' | 'LABEL' | 'LABEL_EXPLODED' | 'MATRIX' | 'MATRIX_EXPLODED' | 'FORM_EXPLODED' | 'FORM' | 'SPACE_DELIMITED_EXPLODED' | 'SPACE_DELIMITED' | 'PIPE_DELIMITED_EXPLODED' | 'PIPE_DELIMITED' | 'DEEP_OBJECT' - `not` boolean - `respondBeforeBody` boolean: If true, MockServer responds to a matching request before consuming its body and may close the connection. Required: the matcher must not specify a body matcher, and the action must be RESPONSE or ERROR. ## Response `200` the template was evaluated; valid says whether it rendered a usable response or request - object - `templateType` string - `actionType` string - `valid` boolean: true when the template rendered a valid response (or request); serving an invalid template answers 500, or with templateFailureAsServerError=false an invalid response template answers 404 and an invalid forward template 502 - `durationMillis` integer - `renderedResponse` object: the rendered response, for a valid RESPONSE_TEMPLATE - `renderedRequest` object: the rendered request, for a valid FORWARD_TEMPLATE - `renderedOutput` string: the raw rendered text, when it is not a valid response or request or is too large to return as an object - `renderedOutputTruncated` boolean: true when renderedOutput was cut to its first 65536 characters - `timedOut` boolean - `error` object - `message` string - `line` integer: 1-based template line of the failure, when the engine reports one - `column` integer: 1-based template column of the failure, when the engine reports one - `messageTruncated` boolean: true when message was cut to its first 8192 characters - `hint` string - `hintTruncated` boolean: true when hint was cut to its first 8192 characters - `validationErrors` string: why the rendered output is not a valid response or request - `validationErrorsTruncated` boolean: true when validationErrors was cut to its first 8192 characters - `warnings` object[] - `message` string - `messageTruncated` boolean: true when message was cut to its first 1024 characters - `line` integer - `column` integer ## Other responses - `400`: the body is missing or invalid - `429`: the maximum number of dry runs are already running --- [API](https://skmtc.dev/mock-server/apis/mockserver-api.md) · [All operations](https://skmtc.dev/mock-server/apis/mockserver-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mock-server/apis/mockserver-api/revisions/9239b693996e?raw)