Skip to content

REST.md

Latest commit

 

History

History
462 lines (276 loc) · 9.28 KB

REST.md

File metadata and controls

462 lines (276 loc) · 9.28 KB
Raw
layout doc
title REST Module - Codeception - Documentation

REST Module

For additional reference, please review the source

Module for testing REST WebService.

This module can be used either with frameworks or PHPBrowser. It tries to guess the framework is is attached to.

Whether framework is used it operates via standard framework modules. Otherwise sends raw HTTP requests to url via PHPBrowser.

Status

Configuration

  • url optional - the url of api

This module requires PHPBrowser or any of Framework modules enabled.

Example

modules:
   enabled: [PhpBrowser, REST]
   config:
      PhpBrowser:
         url: http://serviceapp/
      REST:
         url: 'http://serviceapp/api/v1/'

Public Properties

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

amBearerAuthenticated

Adds Bearer authentication via access token.

  • param $accessToken

amDigestAuthenticated

s Digest authentication via username/password.

ram $username ram $password

amHttpAuthenticated

Adds HTTP authentication via username/password.

  • param $username
  • param $password

dontSeeHttpHeader

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

  • param $name
  • param $value

dontSeeResponseCodeIs

Checks that response code is not equal to provided value.

  • param $code

dontSeeResponseContains

Checks whether last response do not contain text.

  • param $text

dontSeeResponseContainsJson

Opposite to seeResponseContainsJson

  • param array $json

dontSeeResponseJsonMatchesJsonPath

Opposite to seeResponseJsonMatchesJsonPath

  • param array $jsonPath

grabDataFromJsonResponse

Returns data from the current JSON response using specified path so that it can be used in next scenario steps.

this method is deprecated in favor of grabDataFromResponseByJsonPath

Example:

{% highlight php %}

grabDataFromJsonResponse('user.user_id'); $I->sendPUT('/user', array('id' => $user_id, 'name' => 'davert')); ?>

{% endhighlight %}

@deprecated please use grabDataFromResponseByJsonPath

  • param string $path @return string

grabDataFromResponseByJsonPath

Returns data from the current JSON response using JSONPath as selector. JsonPath is XPath equivalent for querying Json structures. Try your JsonPath expressions online. Even for a single value an array is returned.

This method require flow/jsonpath library to be installed.

Example:

{% highlight php %}

grabDataFromJsonResponse('$..users[0].id'); $I->sendPUT('/user', array('id' => $firstUser[0], 'name' => 'davert')); ?>

{% endhighlight %}

  • param $jsonPath @return array @version 2.0.9 \Exception

grabHttpHeader

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

grabResponse

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

Example:

{% highlight php %}

grabResponse(); $I->sendPUT('/user', array('id' => $user_id, 'name' => 'davert')); ?>

{% endhighlight %}

@version 1.1 @return string

haveHttpHeader

Sets HTTP header

  • param $name
  • param $value

seeHttpHeader

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

  • param $name
  • param $value

seeHttpHeaderOnce

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 %}

seeHttpHeaderOnce('Cache-Control'); ?>>

{% endhighlight %}

  • param $name

seeResponseCodeIs

Checks response code equals to provided value.

  • param $code

seeResponseContains

Checks whether the last response contains text.

  • param $text

seeResponseContainsJson

Checks whether the last JSON response contains provided array. The response is converted to array with json_decode($response, true) Thus, JSON is represented by associative array. This method matches that response array contains provided array.

Examples:

{% highlight php %}

seeResponseContainsJson(array('name' => 'john')); // response {user: john, profile: { email: john@gmail.com }} $I->seeResponseContainsJson(array('email' => 'john@gmail.com')); ?>

{% endhighlight %}

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

  • param array $json

seeResponseEquals

Checks if response is exactly the same as provided.

  • param $response

seeResponseIsJson

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

seeResponseIsXml

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

seeResponseJsonMatchesJsonPath

Checks if json structure in response matches JsonPath. JsonPath is XPath equivalent for querying Json structures. Try your JsonPath expressions online. This assertion allows you to check the structure of response json.

This method require flow/jsonpath library to be installed.

{% 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 %}

seeResponseJsonMatchesJsonPath('$.store.book[*].author'); // first book in store has author $I->seeResponseJsonMatchesJsonPath('$.store.book[0].author'); // at least one item in store has price $I->seeResponseJsonMatchesJsonPath('$.store..price'); ?>

{% endhighlight %}

@version 2.0.9

seeResponseJsonMatchesXpath

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 %}

seeResponseJsonMatchesXpath('//store/book/author'); // first book in store has author $I->seeResponseJsonMatchesXpath('//store/book[1]/author'); // at least one item in store has price $I->seeResponseJsonMatchesXpath('/store//price'); ?>

{% endhighlight %}

@version 2.0.9

sendDELETE

Sends DELETE request to given uri.

  • param $url
  • param array $params
  • param array $files

sendGET

Sends a GET request to given uri.

  • param $url
  • param array $params

sendHEAD

Sends a HEAD request to given uri.

  • param $url
  • param array $params

sendLINK

Sends LINK request to given uri.

  • param $url
  • param array $linkEntries (entry is array with keys "uri" and "link-param")

@link http://tools.ietf.org/html/rfc2068#section-19.6.2.4

@author samva.ua@gmail.com

sendOPTIONS

Sends an OPTIONS request to given uri.

  • param $url
  • param array $params

sendPATCH

Sends PATCH request to given uri.

  • param $url
  • param array $params
  • param array $files

sendPOST

Sends a POST request to given uri.

Parameters and files (as array of filenames) can be provided.

  • param $url
  • param array|\JsonSerializable $params
  • param array $files

sendPUT

Sends PUT request to given uri.

  • param $url
  • param array $params
  • param array $files

sendUNLINK

Sends UNLINK request to given uri.

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference