Download the PHP package xp-forge/rest-client without Composer

Rest Client

REST client

Usage

The Endpoint class serves as the entry point to this API. Create a new instance of it with the REST service's endpoint URL and then invoke its resource() method to work with the resources.

Creating: post

Reading: get / head

Updating: put / patch

Deleting: delete

Uploads

Multipart file uploads are initiated by the upload() method, may include parameters and can upload from any input stream.

Deserialization

Automatic result deserialization is supported by passing a type to the value() method.

Error handling

Operations on the Result class raise UnexpectedStatus exceptions. Here's how to access their status and reason:

Authentication

Basic authentication is supported by embedding the credentials in the endpoint URL:

Bearer tokens can also be embedded in the endpoint URL:

Other header-based authentication values can be passed along as follows:

Compression

This library handlees compressed data transparently, sending an Accept-Encoding header containing compression algorithms supported in the PHP setup (based on loaded extensions like e.g. zlib) and using the Content-Encoding response header to determine which algorithm to select.

Testability

This library also includes facilities to ease writing unittests for code making REST API calls. By using the TestEndpoint class and supplying it with routes it should respond to, various scenarios can be easily tested without the need for HTTP protocol and I/O overhead.