README

Relay is a modern, attribute-driven HTTP client for PHP 8.4+. It provides an elegant, type-safe API for building API integrations with support for authentication, caching, rate limiting, retries, and more.

Requirements

Requires PHP 8.4+

Installation

composer require cline/relay

Documentation

Full documentation is available at docs.cline.sh/relay

Guides

• Getting Started - Installation and basic concepts
• Connectors - Creating and configuring API connectors
• Requests - Building typed request objects
• Responses - Working with API responses
• Attributes - HTTP methods, content types, and behavior attributes
• Authentication - Bearer tokens, Basic auth, and custom strategies
• Middleware - Request/response middleware
• Caching - Response caching strategies
• Rate Limiting - Client-side rate limiting
• Resilience - Retries and circuit breakers
• Pagination - Handling paginated APIs
• Pooling - Concurrent request execution
• Testing - Mocking and fixtures
• Debugging - Request/response inspection
• Generators - Artisan scaffolding commands
• Advanced Usage - DTOs, GraphQL, streaming, and more

Change log

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

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

Credits

• Brian Faust
• All Contributors

License

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