stephenjude / breeze-api
0.1.0
2021-08-14 09:06 UTC
Requires
- php: ^7.3|^7.4|^8.0
- illuminate/filesystem: ^8.0
- illuminate/support: ^8.0
- illuminate/validation: ^8.0
This package is auto-updated.
Last update: 2023-03-07 23:47:24 UTC
README
介绍
Breeze Api 提供了一个最小化和简单的起点,用于构建带有 API 身份验证的 Laravel 应用程序。
身份验证 API 使用 Enlighten 进行文档编写,并通过 Laravel Responder 转换,测试则通过 Api Test Helper 进行断言。
Breeze Api 将身份验证控制器、路由和数据转换器发布到您的应用程序中,可以轻松根据您自己的应用程序需求进行自定义。
Laravel Breeze 由 Sanctum、Laravel Responder、Enlighten 和 Api Test Helper 支持。
开始使用非常简单
laravel new my-app
cd my-app
composer require stephenjude/breeze-api --dev
php artisan breeze-api:install
生成更多文档
Breeze Api 生成用于生成的身份验证 API 的文档,但随着您构建应用程序,您将需要生成更多文档。所有生成文档的配置都已生成。
按照以下简单步骤操作
- 执行
php artisan enlighten:migrate
命令以准备您的数据库进行测试。 - 执行
php artisan enlighten
命令以运行所有测试套件。 - 执行
php artisan enlighten:export
命令以导出文档。
查看 Enlighten 文档以获取有关如何生成 API 文档的更多详细信息。
贡献
感谢您考虑为 Breeze 贡献!您可以在 这里 阅读贡献指南。
行为准则
为了确保 Laravel 社区对所有人都友好,请查阅并遵守 行为准则。
安全漏洞
请查看 我们的安全策略 了解如何报告安全漏洞。
许可证
Laravel Breeze Api 是开源软件,根据 MIT 许可证 授权。