README

A PHP SDK for the JSON Placeholder API.

Installation

You can install the package via composer:

composer require alphaolomi/json-placeholder

Usage

$api = new Json\Api();

$users = $api->users()->list();

foreach($users as $user) {
    echo $user->name;
}

Shorthand

$users =  (new Json\Api())->users()->list();

print_r($users);

// array:10 [
//   0 => array:8 [
//     "id" => 1
//     "name" => "Leanne Graham"
//     "username" => "Bret"
//     "email" => "Sincere@april.biz"
//     "address" => array:5 [▶]
//     "phone" => "1-770-736-8031 x56442"
//     "website" => "hildegard.org"
//     "company" => array:3 [▶]
//   ]
//   1 => array:8 [▶]
// ]

Paginated Results

You may prefer to retrieve all the results from the paginated requests by using the paginator method on the SDK.

$api = new Json\Api();

$results = $api->users()->paginate();

foreach($results as $result) {
    // Handle result
    echo $result->name;
}

Available Resources

• Users
  • List all users
  • Get a single user
  • Create a user
  • Update a user
  • Delete a user
  • Paginate users

Testing

Using PestPHP Testing framework, run the following command to execute the tests.

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Alpha Olomi
• All Contributors

License

The MIT License (MIT). Please see License File for more information.