salient/curler

The curler package of the Salient toolkit

v0.99.53 2024-09-17 00:03 UTC

README

The Curler component of the Salient toolkit

Latest Stable Version License CI Status Code Coverage

salient/curler provides an HTTP client optimised for exchanging data with RESTful API endpoints.

  • Simple, fluent interface for sending HEAD, GET, POST, PUT, PATCH and DELETE requests
  • Flexible query string and payload handling
  • Uses generators to iterate over data from endpoints that use pagination
  • Response cache for HEAD, GET and optionally POST requests1
  • Cookie handling and persistence
  • Uses PSR-7 request, response and stream interfaces
  • Implements PSR-18 (HTTP Client)
  • Behaviour can be customised via stackable middleware
  • Generates HTTP Archive (HAR) files for debugging and analysis
<?php
$curler = new \Salient\Curler\Curler('https://api.github.com/repos/salient-labs/toolkit/releases/latest');
echo 'Latest release: ' . $curler->get()['tag_name'] . \PHP_EOL;

Documentation

API documentation for salient/curler tracks the main branch of the toolkit's GitHub repository, where further documentation can also be found.