https://github.com/myerscode/laravel-sub-request
A helper and facade for making internal API sub requests to your application
https://github.com/myerscode/laravel-sub-request
facade helper laravel sub-request
Last synced: 6 days ago
JSON representation
A helper and facade for making internal API sub requests to your application
- Host: GitHub
- URL: https://github.com/myerscode/laravel-sub-request
- Owner: myerscode
- License: mit
- Created: 2017-10-05T21:52:27.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2026-03-24T11:47:30.000Z (15 days ago)
- Last Synced: 2026-03-25T14:55:47.816Z (14 days ago)
- Topics: facade, helper, laravel, sub-request
- Language: PHP
- Size: 43 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Sub Request
A helper and facade for making internal sub requests to your application API.
[](https://packagist.org/packages/myerscode/laravel-sub-request)
[](https://packagist.org/packages/myerscode/laravel-sub-request)
[](https://packagist.org/packages/myerscode/laravel-sub-request)
[](https://github.com/myerscode/laravel-sub-request/blob/main/LICENSE)
[](https://github.com/myerscode/laravel-sub-request/actions/workflows/tests.yml)
[](https://codecov.io/gh/myerscode/laravel-sub-request)
By sending a sub request within the application, you can consume your application's API without sending separate, slower HTTP requests.
## Requirements
- PHP 8.5+
- Laravel 13.x
## Install
```bash
composer require myerscode/laravel-sub-request
```
The package will be auto-discovered by Laravel.
## Usage
You can inject the `Dispatcher` into your class, use the `SubRequest` facade, or use the global `subrequest` helper.
```php
use Myerscode\Laravel\SubRequest\Dispatcher;
use Myerscode\Laravel\SubRequest\SubRequest;
class MyController
{
public function __construct(private readonly Dispatcher $subRequest) {}
// Using dependency injection
public function withInjection()
{
return $this->subRequest->post('/auth', ['foo' => 'bar']);
}
// Using the facade
public function withFacade()
{
return SubRequest::dispatch('GET', '/details', ['foo' => 'bar']);
}
// Using the helper
public function withHelper()
{
return subrequest('GET', '/details', ['foo' => 'bar']);
}
}
```
### Available Methods
The `Dispatcher` provides shortcut methods for all HTTP verbs:
```php
$dispatcher->get('/url', $data);
$dispatcher->post('/url', $data);
$dispatcher->put('/url', $data);
$dispatcher->patch('/url', $data);
$dispatcher->delete('/url', $data);
$dispatcher->options('/url', $data);
```
### Custom Headers
All methods accept an optional `$headers` array as the last parameter, allowing you to set custom headers on the sub request:
```php
// Set Authorization and Accept headers
$dispatcher->get('/api/users', [], [
'Authorization' => 'Bearer my-token',
'Accept' => 'application/json',
]);
// Works with the facade and helper too
SubRequest::dispatch('GET', '/api/users', [], ['Authorization' => 'Bearer my-token']);
subrequest('GET', '/api/users', [], ['Authorization' => 'Bearer my-token']);
```
Headers are applied to the sub request and automatically restored to their original values after dispatch.
### Cookies
All methods accept an optional `$cookies` array as the last parameter, allowing you to forward or set cookies on the sub request:
```php
// Set cookies on the sub request
$dispatcher->get('/api/profile', [], [], [
'session_id' => 'abc123',
'token' => 'my-auth-token',
]);
// Combine headers and cookies
$dispatcher->post('/api/data', ['key' => 'value'], [
'Accept' => 'application/json',
], [
'session_id' => 'abc123',
]);
// Works with the facade and helper too
SubRequest::dispatch('GET', '/api/profile', [], [], ['session_id' => 'abc123']);
subrequest('GET', '/api/profile', [], [], ['session_id' => 'abc123']);
```
Cookies are applied to the sub request and automatically restored to their original values after dispatch.
### Middleware Control
Use `withoutMiddleware()` to skip specific middleware on a sub request:
```php
use App\Http\Middleware\Authenticate;
use App\Http\Middleware\RateLimiter;
// Skip a single middleware
$dispatcher->withoutMiddleware(Authenticate::class)->get('/api/internal');
// Skip multiple middleware by chaining
$dispatcher
->withoutMiddleware(Authenticate::class)
->withoutMiddleware(RateLimiter::class)
->post('/api/internal', $data);
// Or pass an array
$dispatcher->withoutMiddleware([Authenticate::class, RateLimiter::class])->get('/api/internal');
```
The middleware exclusion is automatically reset after each dispatch, so subsequent calls will run all middleware as normal.
## License
MIT