Laravel Compass is an elegant REST assistant for the Laravel framework that you can use to test API calls and create API documentation.
In other words Laravel Compass provides automatically endpoints for GET, POST, PUT/PATCH, DELETE, various auth mechanisms and other utility endpoints based on Laravel routes in your project.
However Checkout the official Github Repository
Steps to Install
You may use Composer to install :
composer require davidhsianturi/laravel-compass --dev
Once Composer installation is completed then publish its assets using the compass:install
Artisan command.
After installing Compass, you should also run the migrate
command:
php artisan compass:install
php artisan migrate
Updating Compass
When updating Compass, you should re-publish the assets:
php artisan compass:publish
Migration Customization
In addition, if you are not going to use Compass’ default migrations, you should call the Compass::ignoreMigrations
method in the register
method of your AppServiceProvider
. You may export the default migrations using the php artisan vendor:publish --tag=compass-migrations
command.
Configuring Laravel Compass
After that, the primary configuration file will be located at config/compass.php
return [
/*
|--------------------------------------------------------------------------
| Compass Path
|--------------------------------------------------------------------------
|
| This is the URI path where Compass will be accessible from. Feel free
| to change this path to anything you like.
|
*/
'path' => env('COMPASS_PATH', 'compass'),
/*
|--------------------------------------------------------------------------
| Laravel Routes
|--------------------------------------------------------------------------
|
| This is the routes rules that will be filtered for the requests list. use
| * as a wildcard to match any characters. note that the following array
| list "exclude" must be referenced by the route name.
| "base_uri" is a string value as a comparison for grouping the routes.
|
*/
'routes' => [
'domains' => [
'*',
],
'prefixes' => [
'*',
],
'exclude' => [
'compass.*',
'debugbar.*',
],
'base_uri' => '*',
],
/*
|--------------------------------------------------------------------------
| Compass Storage Driver
|--------------------------------------------------------------------------
|
| This configuration options determines the storage driver that will
| be used to store your API calls and routes. In addition, you may set any
| custom options as needed by the particular driver you choose.
|
*/
'driver' => env('COMPASS_DRIVER', 'database'),
'storage' => [
'database' => [
'connection' => env('DB_CONNECTION', 'mysql'),
],
],
/*
|--------------------------------------------------------------------------
| API Documentation Builder
|--------------------------------------------------------------------------
|
| Compass will write and build contents in Documentarian markdown files
| and as a generator to generate the API documentation which is a
| PHP port of the popular Slate API documentation tool.
|
| @see https://github.com/mpociot/documentarian
|
*/
'builder' => 'slate',
'template' => [
'slate' => [
'output' => 'public/docs',
'example_requests' => [
'bash',
],
],
],
];
You can build the API documentation using the php artisan compass:build
command and go to yourproject.test/docs/index.html
to see the result.
In conclusion how to embed Rest Client within Laravel Framework.
I hope you like Laravel Compass – A REST client inside your Laravel Project article. Checkout All article here

