Skip to content

Commit d3380e1

Browse files
Add "Examples" attribute example for associative keys
1 parent 6c31a10 commit d3380e1

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/AdvancedUsage.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,32 @@ class EndpointCest
265265

266266
```
267267

268+
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.
269+
```php
270+
<?php
271+
272+
namespace Tests\Api;
273+
274+
use \Tests\Support\ApiTester;
275+
use \Codeception\Attribute\Examples;
276+
use \Codeception\Example;
277+
278+
class EndpointCest
279+
{
280+
281+
#[Examples(url: '/api', expectedReponseCode: 200)]
282+
#[Examples(url: '/api/protected', expectedReponseCode: 401)]
283+
#[Examples(url: '/api/not-found-url', expectedReponseCode: 404)]
284+
#[Examples(url: '/api/faulty', expectedReponseCode: 500)]
285+
public function checkEndpoints(ApiTester $I, Example $example)
286+
{
287+
$I->sendGet($example['url']);
288+
$I->seeResponseCodeIs($example['expectedReponseCode']);
289+
}
290+
}
291+
292+
```
293+
268294
## Example Annotation
269295

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

0 commit comments

Comments
 (0)