README

Introduction

Breeze Api provides a minimal and simple starting point for building a Laravel application with API authentication.

Auth APIs are documented with Enlighten and transformed with Laravel Responder and the tests asserted with Api Test Helper.

Breeze Api publishes authentication controllers, routes and data transformers to your application that can be easily customized based on your own application's needs.

Laravel Breeze is powered by Sanctum , Laravel Responder, Enlighten and Api Test Helper.

Getting started couldn't be easier:

laravel new my-app

cd my-app

composer require stephenjude/breeze-api --dev

php artisan breeze-api:install

Generating More Documentations

Breeze Api generates documentations for the scaffolded Authentication APIs but as you build your app, you will need to generate more. All configurations for generating documentations has been scaffolded.

Follow these simple steps:

Execute the php artisan enlighten:migrate command to prepare your database for testing.
Execute the php artisan enlighten command to run all your test suites.
Execute the php artisan enlighten:export command to export documentation.

Check Enlighten docs for more details on how to generate API documentations.

Contributing

Thank you for considering contributing to Breeze! You can read the contribution guide here.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

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

stephenjude / breeze-api

Maintainers

Details