SDK Toolbox docs
SDK Toolbox documentation
PHP ^8.316 pages
Docs for v0.0.1, from GitHub.
Pages in these docs
Start with Getting started. It builds a small SDK from nothing, test included, and every other page builds on what it sets up.
| Page | What it covers |
|---|---|
| Getting started | A connector, typed requests, resources and a test |
| Requests and bodies | Paths and the base URI, queries, headers, JSON, forms, multipart, Merge Patch, JSON Patch |
| Errors | The exception hierarchy, RFC 9457 problems, mapping an API’s own errors |
| Authentication | Bearer, Basic, API keys, and OAuth 2.0 with PKCE, device flow and refresh |
| Results and pagination | Typed results through a hydrator, and paginating by Link, cursor, offset or page |
| Reliability | Retries, Retry-After, deadlines, Idempotency-Key, rate limits and the throttle |
| HTTP semantics | Caching, conditional requests, Deprecation and Sunset, Prefer and 202 polling |
| Observability | PSR-3 logging, PSR-14 events, W3C Trace Context and OpenTelemetry |
| Middleware | The pipeline’s order, and writing your own |
| Testing | The fake client, fake time, recorded fixtures and type assertions |
| Integrity and webhooks | Content-Digest, HTTP Message Signatures, and verifying webhooks |
| Security | What the defaults protect against, and how |
| Standards | Every RFC, draft and PSR the toolbox implements, and how far |
| Porting an existing SDK | Moving an SDK you already have onto the toolbox |
| Compared with Saloon | Where the two differ, and when Saloon is the better choice |
Everything here is for version 0.x. Until 1.0, a minor release can change a public API, and the changelog will say so.