Skip to content

Commit 3664989

Browse files
authored
Merge pull request #15 from igorsantos07/patch-2
Clarify custom header configs for REST module
2 parents f85b896 + 292a89c commit 3664989

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/Codeception/Module/REST.php

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,23 @@
3535
* * shortDebugResponse *optional* - amount of chars to limit the api response length
3636
*
3737
* This module requires PHPBrowser or any of Framework modules enabled.
38+
*
39+
* In case you need to configure low-level HTTP fields, that's done on the PHPBrowser level.
40+
* Check the example below for details.
3841
*
3942
* ### Example
4043
*
4144
* modules:
4245
* enabled:
4346
* - REST:
4447
* depends: PhpBrowser
45-
* url: 'http://serviceapp/api/v1/'
48+
* url: &url 'http://serviceapp/api/v1/' # you only need the &url anchor for further PhpBrowser configs
4649
* shortDebugResponse: 300 # only the first 300 chars of the response
50+
* config:
51+
* PhpBrowser:
52+
* url: *url # repeats the URL from the REST module; not needed if you don't have further settings like below
53+
* headers:
54+
* Content-Type: application/json
4755
*
4856
* ## Public Properties
4957
*

0 commit comments

Comments
 (0)