qcyx/laravel-api

laravel的api设计

3.0 2021-12-22 07:46 UTC

Requires

• php: ^7.0
• overtrue/laravel-lang: ^5.0

MIT

• Edward Yu

README

基于Laravel设计的Restful风格api三方包

该扩展包实现了 自动curd，场景验证，自定义异常，统一json返回等

安装说明：

为了不破坏框架现有的功能，不增加额外学习成本，使用了继承的方式，可随意覆盖或者选择性继承

前提： 在项目composer.json根节点下添加如下自定义仓库配置:

1. composer require qcs/laravel-api
2. laravel 5.5以上自动发现服务提供者，无需操作，5.5以下版本请手动添加
3. 发布配置文件 php artisan vendor:publish --provider="QCS\LaravelApi\Providers\LaravelApiProvider"，
4. 继承基础控制器BaseController（命名空间：QCS\LaravelApi\Controllers）
5. 继承基础异常类BaseHandler （命名空间：QCS\LaravelApi\Exceptions）
6. 继承基础模型类 BaseModel （命名空间：QCS\LaravelApi\Models）
7. 继承基础验证类 BaseValidate （命名空间：QCS\LaravelApi\Validates）

自动curd： 基于restful api的控制器继承基类之后，并且需要建立对应的模型与验证类，注入到控制器中，无需书写index，update，show，destroy，store方法，可自动处理基本的curd需求，自动处理验证请求。

统一json返回： 在需要返回处 引入ResultTrait， 调用对应的this->success,this->error,this->noData 可统一返回json格式响应，实现了自定义异常，可处理相关逻辑