Dsl
Related Docs:
object Dsl
| package resttest
HttpClient
HttpClient
The HTTP Methods used to make a request
The HTTP Methods used to make a request
The HTTP Request
The HTTP Request
The HTTP RequestBuilder
The HTTP RequestBuilder
The HTTP Response
The HTTP Response
Add operator support to Extractors these are used to generate an Assertion using the extracted value.
Add operator support to Extractors these are used to generate an Assertion using the extracted value.
GET url "http://api.rest.org/person" assert (StatusCode === Status.Ok)The following operations are added to all Extractors
$ - extractor === expected - the extracted value is equal to the expected value.
$ - extractor !== expected - the extracted value is not equal to the expected value.
$ - extractor in (expected1, expected2, ...) - the extracted value is in the list of expected values.
$ - extractor notIn (expected1, expected2, ...) - the extracted value is in the list of expected values.
The following operations are added to Extractors that support scala.math.Ordering.
More precisely these operations are added to Extractor[T] if there exists an implicit
Ordering[T] for any type T.
$ - extractor < expected - the extracted value is less than the expected value.
$ - extractor <= expected - the extracted value is less than or equal to the expected value.
$ - extractor > expected - the extracted value is greater than the expected value.
$ - extractor <= expected - the extracted value is greater than or equal to the expected value.
Extend the default request's configuration so that partially configured requests to be reused.
Extend the default request's configuration so that partially configured requests to be reused. Foe example:
using(_ url "http://api.rest.org/person") { implicit rb => GET asserting (StatusCode === Status.OK, jsonBodyAsList[Person] === EmptyList) val id = POST body personJson asserting (StatusCode === Status.Created) returning (Header("X-Person-Id")) GET / id asserting (StatusCode === Status.OK, jsonBodyAs[Person] === Jason) }
a function to configure the default request
the current default request, implicitly resolved, defaults to the empty request
Provides a DSL for simplifying REST system tests. This is meant to be used with ScalaTest or similar testing framework.
For example to post a json document to a REST endpoint and check the statusCode:
Or to get a json document from a REST endpoint and convert the json array to a List of Person objects:
Finally a more complete example that using a ScalaTest Spec to verify a simple REST API.
Configuring a Request
The DSL centers around the Api.RequestBuilder, which specifies the properties of the request. Most expressions begin with the HTTP Api.Method followed by a call to RichRequestBuilder, this converts the
Methodto a Api.RequestBuilder. The resultingRequestBuildercontains both theMethodand secondary property. For example:GET url "http://api.rest.org/person"is the same as
RequestBuilder().withMethod(GET).withUrl("http://api.rest.org/person")The
RequestBuilderDSL also supports default values passed implicitly into expressions, for example:creates a
RequestBuilderwith a method, url and accept header set. The default values are normal expressed the with the using expression.Executing a Request
There are three ways to execute a request: RichRequestBuilder
.execute, RichResponse.returning, RichRequestBuilder.asserting, these can all be applied toRequestBuilderinstances.The
executemethod executes the request with the implicit Api.HttpClient and returns theResponse.The
returningmethod executes the request like theexecutemethod, except it applies one or more Extractors to theResponseto return only the extracted information.The
assertingmethod executes the request like theexecutemethod, except it verifies the specified value of one or moreResponsevalues.assertingis normally used with extractors, see [RichExtractor] for more information.assertingandreturningmethods can be used in the same expression.Working with Extractors
Extractors are simply functions that take a Api.Response are extract or convert part of its contents. Extracts are written to assume that the data they require is in the response, if it is not they throw an Exception (failing the test). See Extractors for more information on the available default
Extractors And how to implement your own.