mikelgoig/codeception-rest

Codeception module for testing REST services.

3.3.1 2025-01-18 19:20 UTC

Requires

• php: 8.3.*
• codeception/codeception: ^5.1
• codeception/module-rest: ^3.4
• coduo/php-matcher: ^6.0
• webmozart/assert: ^1.11

Requires (Dev)

• captainhook/captainhook-phar: ^5.24
• captainhook/hook-installer: ^1.0
• jetbrains/phpstorm-attributes: ^1.2
• mikelgoig/easy-coding-standard-rules: ^1.1
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^2.1
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpstan/phpstan-webmozart-assert: ^2.0
• ramsey/conventional-commits: ^1.5
• symplify/easy-coding-standard: ^12.5

MIT

• Mikel Goig

• rest
• testing
• codeception
• gherkin
• dev

README

Codeception Module for testing REST services

Created by Mikel Goig.

View Repository

This Codeception module provides you with actions for testing REST services.

It extends the Codeception's official REST module, adding some helpers and Gherkin format support.

😎 Installation

1. Install this package using Composer:

   composer require --dev mikelgoig/codeception-rest

🛠️ Configuration

1. Add the Codeception module to your config file:

   modules:
     enabled:
       - MikelGoig\Codeception\Module\Rest:
           depends: REST
           multipart_boundary: foo

   • multipart_boundary optional - the boundary parameter for multipart requests

2. To set up Gherkin steps, enable the gherkin part of the module:

   modules:
     enabled:
       - MikelGoig\Codeception\Module\Rest:
           # ...
           part: gherkin