This API SDK was automatically generated by APIMATIC v2.0.
The generated code might need to be configured with your API credentials. To do that, open the file "Configuration.php" and edit it's contents.
The generated code has dependencies over external libraries. These dependencies
are defined in the composer.json
file. To resolve these dependencies, we use
the Composer package manager. You will need internet access for this.
- If you have not already installed Composer, install the latest version.
- Once Composer is installed, from commandline, run
composer install
to install dependencies.
For using this SDK do the following:
-
Use Composer to install the dependencies. See the section "How To Build".
-
See that you have configured your SDK correctly. See the section "How To Configure".
-
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable autoloading of classes.
require_once "vendor/autoload.php";
-
Import the SDK client in your project:
use RaasLib\RaasClient;
-
Instantiate the client. After this, you can now get the controllers and call the respective methods:
$client = new RaasClient(); $controller = $client->getStatus();
Unit tests in this SDK can be run using PHPUnit.
- First install the dependencies using composer including the
require-dev
dependencies. - Run
vendor\bin\phpunit --verbose
from commandline to execute tests. If you have installed PHPUnit globally, run tests usingphpunit --verbose
instead.
You can change the PHPUnit test configuration in the phpunit.xml
file.