进行搜索usamamuneerchaudhary / laravel-api-boilerplate
简单的Laravel API样板，使用Laravel Passport创建可立即使用的REST API
Requires
- php: ^7.3.7
- akaunting/firewall: ^1.1
- barryvdh/laravel-cors: ^0.11.3
- facade/ignition: ^1.11
- fideloper/proxy: ^4.0
- laravel/framework: ^6.0
- laravel/passport: ^7.4
- laravel/tinker: ^1.0
Requires (Dev)
- barryvdh/laravel-debugbar: ^3.2
- beyondcode/laravel-dump-server: ^1.0
- fzaninotto/faker: ^1.4
- mockery/mockery: ^1.0
- nunomaduro/collision: ^3.0
- phpunit/phpunit: ^7.5
This package is auto-updated.
Last update: 2024-09-05 17:14:41 UTC
README
Laravel API Boilerplate使用Laravel Passport
Laravel API Boilerplate是创建第一个API的起点。
它建立在
- Laravel框架 - laravel/laravel
- Laravel Passport - laravel/passport
- Laravel-CORS barryvdh/laravel-cors
安装
-
运行
composer create-project usamamuneerchaudhary/laravel-api-boilerplate myfirstApi; -
将
.env.example重命名为.env -
通过
php artisan passport:install生成Passport加密密钥和访问令牌 -
通过
php artisan key:generate生成应用程序密钥 -
在数据库连接后，运行
php artisan migrate。对于用户伪数据，运行php artisan migrate --seed。更多信息请参阅database\seeds\UserTableSeeder.php。 -
为了测试电子邮件，您可以设置MailTrap。
-
好了，亲爱的，它已经在您的服务器上运行了。
项目的必备条件
- PHP
v7.3或更高版本。
主要功能
可用的认证控制器
您可以在命名空间App\Http\Controllers\API\Auth下找到认证控制器。
验证
在命名空间App\Http\Request\API\Auth下，还有每个操作（登录、注册、恢复和重置）的验证规则。
端点
- 登录：
POST api/v1/login - 注册：
POST api/v1/register - 恢复：
POST api/v1/recover - 重置：
POST api/v1/reset - 查找重置令牌：
GET api/v1/reset/{token} - 注销：
GET api/v1/logout - 验证电子邮件：
api/v1/user/verify/email/{token}
请注意，API路由以v1为前缀，您可以在App\Providers\RouteServiceProvider.php中更改此设置。
独立的路由文件
所有API路由都可以在routes/api.php文件中找到。
防火墙
我们使用akaunting/firewall 来保护我们的API。
角色与权限
更简单地将角色和权限分配给用户的方法。您可以在usamamuneerchaudhary/roles-permissions上了解更多我们在这里所做的事情。
CRUD生成器
一个简单的CRUD生成器包已经设置为即用型，以让您无需任何麻烦即可继续。
创建端点
您可以在routes/api.php文件中的auth:api中间件组下创建端点。
跨源资源共享
如果您想为特定路由或路由组启用CORS，只需在这些路由上使用cors中间件即可。
感谢barryvdh/laravel-cors包，您可以轻松处理CORS。有关更多信息，请参阅此页面的文档。
许可
此项目是开源软件，根据MIT许可证授权。