Skip to content

Commit 1f40575

Browse files
committed
Add note that Rest API testing requires the module-rest package
After working through the API testing documentation and attempting to run the API tests, I encountered the following error: Module REST is not installed. Use Composer to install corresponding package: composer require codeception/module-rest --dev This change updates the documentation to cover this requirement, so that it's not discovered when running the API tests.
1 parent ef6e197 commit 1f40575

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/10-APITesting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ We will put all the api tests there.
1919

2020
## REST API
2121

22+
> **NOTE:** REST API testing requires the `codeception/module-rest` package to be installed.
23+
2224
The REST web service is accessed via HTTP with standard methods: `GET`, `POST`, `PUT`, `DELETE`. They allow users to receive and manipulate entities from the service. Accessing a WebService requires an HTTP client, so for using it you need the module `PhpBrowser` or one of framework modules set up. For example, we can use the `Symfony` module for Symfony2 applications in order to ignore web server and test web service internally.
2325

2426
Configure modules in `api.suite.yml`:

0 commit comments

Comments
 (0)