Skip to content

Commit 0aff92f

Browse files
authored
Merge pull request #867 from sascha-egerer/patch-2
Add "Examples" attribute example for associative keys
2 parents c66bf1f + d3380e1 commit 0aff92f

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/AdvancedUsage.md

+26
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,32 @@ class EndpointCest
257257
}
258258
```
259259

260+
You can also use [named arguments](https://www.php.net/manual/en/functions.arguments.php#functions.named-arguments) to get an example with associative keys.
261+
```php
262+
<?php
263+
264+
namespace Tests\Api;
265+
266+
use \Tests\Support\ApiTester;
267+
use \Codeception\Attribute\Examples;
268+
use \Codeception\Example;
269+
270+
class EndpointCest
271+
{
272+
273+
#[Examples(url: '/api', expectedReponseCode: 200)]
274+
#[Examples(url: '/api/protected', expectedReponseCode: 401)]
275+
#[Examples(url: '/api/not-found-url', expectedReponseCode: 404)]
276+
#[Examples(url: '/api/faulty', expectedReponseCode: 500)]
277+
public function checkEndpoints(ApiTester $I, Example $example)
278+
{
279+
$I->sendGet($example['url']);
280+
$I->seeResponseCodeIs($example['expectedReponseCode']);
281+
}
282+
}
283+
284+
```
285+
260286
## Example Annotation
261287

262288
As well as the `\Codeception\Attribute\Examples` attribute, available for Cest tests, the `@example` attribute allows you to

0 commit comments

Comments
 (0)