If you use Codeception installed using composer, install this module with the following command:

{% highlight yaml %} composer require --dev codeception/module-rest

{% endhighlight %}

Alternatively, you can enable REST module in suite configuration file and run

{% highlight yaml %} codecept init upgrade4

{% endhighlight %}

This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
Some modules are bundled with PHAR files.
Warning. Using PHAR file and composer in the same project can cause unexpected errors.

Module for testing REST WebService.

This module requires either PhpBrowser or a framework module (e.g. Symfony, Laravel) to send the actual HTTP request.

• url optional - the url of api
• shortDebugResponse optional - number of chars to limit the API response length

{% highlight yaml %}

modules: enabled: - REST: depends: PhpBrowser url: 'https://example.com/api/v1/' shortDebugResponse: 300 # only the first 300 characters of the response

{% endhighlight %}

In case you need to configure low-level HTTP headers, that's done on the PhpBrowser level like so:

{% highlight yaml %}

modules: enabled: - REST: depends: PhpBrowser url: &url 'https://example.com/api/v1/' config: PhpBrowser: url: *url headers: Content-Type: application/json

{% endhighlight %}

JSONPath is the equivalent to XPath, for querying JSON data structures. Here's an Online JSONPath Expressions Tester

• headers - array of headers going to be sent.
• params - array of sent data
• response - last response (string)

• Json - actions for validating Json responses (no Xml responses)
• Xml - actions for validating XML responses (no Json responses)

Conflicts with SOAP module

Allows to send REST request using AWS Authorization

Only works with PhpBrowser Example Config: {% highlight yaml %} yml modules: enabled: - REST: aws: key: accessKey secret: accessSecret service: awsService region: awsRegion

{% endhighlight %} Code: {% highlight php %}

{% endhighlight %}

• param array $additionalAWSConfig @throws ConfigurationException

Adds Bearer authentication via access token.

• param $accessToken
• [Part] json
• [Part] xml

Adds Digest authentication via username/password.

• param $username
• param $password
• [Part] json
• [Part] xml

Adds HTTP authentication via username/password.

• param $username
• param $password
• [Part] json
• [Part] xml

Adds NTLM authentication via username/password. Requires client to be Guzzle >=6.3.0 Out of scope for functional modules.

Example: {% highlight php %}

{% endhighlight %}

• param $username
• param $password @throws ModuleException
• [Part] json
• [Part] xml

Deletes a HTTP header (that was originally added by haveHttpHeader()), so that subsequent requests will not send it anymore.

Example: {% highlight php %}

{% endhighlight %}

• param string $name the name of the header to delete.
• [Part] json
• [Part] xml

Checks if the hash of a binary response is not the same as provided.

{% highlight php %}

{% endhighlight %} Opposite to seeBinaryResponseEquals

• param string $hash the hashed data response expected
• param string $algo the hash algorithm to use. Default md5.
• [Part] json
• [Part] xml

Checks over the given HTTP header and (optionally) its value, asserting that are not there

• param $name
• param $value
• [Part] json
• [Part] xml

Checks that response code is not equal to provided value.

{% highlight php %}

{% endhighlight %}

• param string $jsonPath
• return array Array of matching items @throws \Exception
• [Part] json

Returns the value of the specified header name

• param $name

• param Boolean $first Whether to return the first value or all header values

• return string|array The first header value if $first is true, an array of values otherwise

• [Part] json

• [Part] xml

Returns current response so that it can be used in next scenario steps.

Example:

{% highlight php %}

{% endhighlight %}

• return string
• [Part] json
• [Part] xml

Finds and returns text contents of element. Element is matched by either CSS or XPath

• param $cssOrXPath
• return string
• [Part] xml

Sets a HTTP header to be used for all subsequent requests. Use deleteHeader to unset it.

{% highlight php %}

{% endhighlight %}

• param $name
• param $value
• [Part] json
• [Part] xml

Sets SERVER parameter valid for all next requests.

{% highlight php %}

$I->haveServerParameter('name', 'value');

{% endhighlight %}

Checks if the hash of a binary response is exactly the same as provided. Parameter can be passed as any hash string supported by hash(), with an optional second parameter to specify the hash type, which defaults to md5.

Example: Using md5 hash key

{% highlight php %}

{% endhighlight %}

Example: Using md5 for a file contents

{% highlight php %}

{% endhighlight %} Example: Using sha256 hash

{% highlight php %}

{% endhighlight %}

• param string $hash the hashed data response expected
• param string $algo the hash algorithm to use. Default md5.
• [Part] json
• [Part] xml

Checks over the given HTTP header and (optionally) its value, asserting that are there

• param $name
• param $value
• [Part] json
• [Part] xml

Checks that http response header is received only once. HTTP RFC2616 allows multiple response headers with the same name. You can check that you didn't accidentally sent the same header twice.

{% highlight php %}

{% endhighlight %}

• param $name
• [Part] json
• [Part] xml

Checks response code equals to provided value.

{% highlight php %}

{% endhighlight %}

This method recursively checks if one array can be found inside of another.

• param array $json
• [Part] json

Checks if response is exactly the same as provided.

• [Part] json
• [Part] xml
• param $response

Checks whether last response was valid JSON. This is done with json_last_error function.

• [Part] json

Checks whether last response matches the supplied json schema (https://json-schema.org/) Supply schema as relative file path in your project directory or an absolute path

@see codecept_absolute_path()

• param string $schemaFilename
• [Part] json

Checks whether last response matches the supplied json schema (https://json-schema.org/) Supply schema as json string.

Examples:

{% highlight php %}

{% endhighlight %}

• param string $schema
• [Part] json

Checks whether last response was valid XML. This is done with libxml_get_last_error function.

• [Part] xml

See #jsonpath for general info on JSONPath. Checks if JSON structure in response matches JSONPath.

{% highlight json %}

{ "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }

{% endhighlight %}

{% highlight php %}

{% endhighlight %}

• param string $jsonPath
• [Part] json

Checks if json structure in response matches the xpath provided. JSON is not supposed to be checked against XPath, yet it can be converted to xml and used with XPath. This assertion allows you to check the structure of response json. * {% highlight json %}

{ "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }

{% endhighlight %}

{% highlight php %}

{% endhighlight %}

• param string $xpath
• [Part] json

Checks that JSON matches provided types. In case you don't know the actual values of JSON data returned you can match them by type. It starts the check with a root element. If JSON data is an array it will check all elements of it. You can specify the path in the json which should be checked with JsonPath

Basic example:

{% highlight php %}

{% endhighlight %}

You can check if the record contains fields with the data types you expect. The list of possible data types:

• string
• integer
• float
• array (json object is array as well)
• boolean
• null

You can also use nested data type structures, and define multiple types for the same field:

{% highlight php %}

{% endhighlight %}

You can also apply filters to check values. Filter can be applied with a : char after the type declaration, or after another filter if you need more than one.

Here is the list of possible filters:

• integer:>{val} - checks that integer is greater than {val} (works with float and string types too).
• integer:<{val} - checks that integer is lower than {val} (works with float and string types too).
• string:url - checks that value is valid url.
• string:date - checks that value is date in JavaScript format: https://weblog.west-wind.com/posts/2014/Jan/06/JavaScript-JSON-Date-Parsing-and-real-Dates
• string:email - checks that value is a valid email according to http://emailregex.com/
• string:regex({val}) - checks that string matches a regex provided with {val}

This is how filters can be used:

{% highlight php %}

{% endhighlight %}

You can also add custom filters by using {@link JsonType::addCustomFilter()}. See JsonType reference.

• [Part] json
• param array $jsonType
• param string $jsonPath @see JsonType

Checks XML response equals provided XML. Comparison is done by canonicalizing both xml`s.

Parameters can be passed either as DOMDocument, DOMNode, XML string, or array (if no attributes).

• param $xml
• [Part] xml

Checks XML response includes provided XML. Comparison is done by canonicalizing both xml`s. Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).

Example:

{% highlight php %}

{% endhighlight %}

• param $xml
• [Part] xml

Checks whether XML response matches XPath

{% highlight php %}