Skip to main content
WritingVideosSpeakingCodeAbout

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.

PageWhat it covers
Getting startedA connector, typed requests, resources and a test
Requests and bodiesPaths and the base URI, queries, headers, JSON, forms, multipart, Merge Patch, JSON Patch
ErrorsThe exception hierarchy, RFC 9457 problems, mapping an API’s own errors
AuthenticationBearer, Basic, API keys, and OAuth 2.0 with PKCE, device flow and refresh
Results and paginationTyped results through a hydrator, and paginating by Link, cursor, offset or page
ReliabilityRetries, Retry-After, deadlines, Idempotency-Key, rate limits and the throttle
HTTP semanticsCaching, conditional requests, Deprecation and Sunset, Prefer and 202 polling
ObservabilityPSR-3 logging, PSR-14 events, W3C Trace Context and OpenTelemetry
MiddlewareThe pipeline’s order, and writing your own
TestingThe fake client, fake time, recorded fixtures and type assertions
Integrity and webhooksContent-Digest, HTTP Message Signatures, and verifying webhooks
SecurityWhat the defaults protect against, and how
StandardsEvery RFC, draft and PSR the toolbox implements, and how far
Porting an existing SDKMoving an SDK you already have onto the toolbox
Compared with SaloonWhere 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.