README.md

Introduction

Laravel Compass is an elegant REST assistant for the Laravel framework that you can use to test API calls and create API documentation. it provides automatically endpoints for GET, POST, PUT/PATCH, DELETE, various auth mechanisms, and other utility endpoints based on Laravel routes in your project.

Installation and usage

In order to install the package, you need add following repositories to your composer file.

    "repositories": {
        "fiveone-digital/laravel-compass": {
            "type": "vcs",
            "url": "git@github.com:fiveone-digital/laravel-compass.git"
        },
        "fiveone-digital/documentarian": {
            "type": "vcs",
            "url": "git@github.com:fiveone-digital/documentarian.git"
        }
    }

and then run following composer require commands

	composer require fiveone-digital/documentarian
	composer require fiveone-digital/laravel-compass

This package requires PHP 8.1 and Laravel 9.0 or higher.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

Laravel Compass is open-sourced software licensed under the MIT license.