Overview

Laravel Compass is a REST assistant designed for the Laravel framework. It allows users to test API calls and generate API documentation. The tool automatically creates endpoints for various HTTP request types and authentication mechanisms based on the Laravel routes in the project.

Features

• API Testing: Easily test API calls within the Laravel framework.
• API Documentation Generation: Generate API documentation for your project.
• Automated Endpoints: Automatically create endpoints for GET, POST, PUT/PATCH, DELETE requests.
• Authentication Support: Provides support for various authentication mechanisms.

Installation

To install Laravel Compass, ensure that your system meets the following requirements: PHP 7.2 and Laravel 6.0 or higher. Follow these steps to install the package:

1. Add Laravel Compass to your project using Composer:

composer require alpha/spade

2. Publish the configuration file:

php artisan vendor:publish --provider="Alpha\Spade\CompassServiceProvider"

3. Access the package configuration file at config/compass.php. Configure the package as needed.

4. Start using Laravel Compass to test API calls and create documentation for your project.

Summary

Laravel Compass is a useful REST assistant for Laravel developers, offering features like API testing, documentation generation, and automated endpoint creation. With its support for authentication mechanisms, it simplifies the process of working with APIs in Laravel projects. Following the installation guide, users can quickly integrate this tool into their projects for seamless API development.