ThinkPHP 通用的API格式封装实例代码

 更新时间:2023年08月29日 14:22:28   作者:杀死一只知更鸟debug  
这篇文章主要介绍了ThinkPHP通用的API格式封装,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

ThinkPHP 通用的API格式封装

1.创建status.php 用于设置通用的状态码返回枚举类

<?php
return[
    "success"=>1,
    "error"=>0,
    "controller_not_found"=>-1,
    "action_not_found"=>-2,
];

2.将API返回格式统一封装

<?php
/**API 统一格式化
 * @param $status
 * @param $message
 * @param $data
 * @param $httpStatus
 * @return \think\response\Json
 */
function show($status,$message,$data=[],$httpStatus=200){
    $result = [
      "status"=>$status,
      "message"=>$message,
      "data"=>$data,
    ];
    return json($result,$httpStatus);
}

3.重写BaseController中的__call方法

在BaseController中重写__call方法,当调用不存在的方法时,就会调用__call方法,会传入请求方法和参数

<?php
declare (strict_types = 1);
namespace app;
use think\App;
use think\exception\ValidateException;
use think\Validate;
/**
 * 控制器基础类
 */
abstract class BaseController
{
    /**
     * Request实例
     * @var \think\Request
     */
    protected $request;
    /**
     * 应用实例
     * @var \think\App
     */
    protected $app;
    /**
     * 是否批量验证
     * @var bool
     */
    protected $batchValidate = false;
    /**
     * 控制器中间件
     * @var array
     */
    protected $middleware = [];
    /**
     * 构造方法
     * @access public
     * @param  App  $app  应用对象
     */
    public function __construct(App $app)
    {
        $this->app     = $app;
        $this->request = $this->app->request;
        // 控制器初始化
        $this->initialize();
    }
    // 初始化
    protected function initialize()
    {}
    /**
     * 验证数据
     * @access protected
     * @param  array        $data     数据
     * @param  string|array $validate 验证器名或者验证规则数组
     * @param  array        $message  提示信息
     * @param  bool         $batch    是否批量验证
     * @return array|string|true
     * @throws ValidateException
     */
    protected function validate(array $data, string|array $validate, array $message = [], bool $batch = false)
    {
        if (is_array($validate)) {
            $v = new Validate();
            $v->rule($validate);
        } else {
            if (strpos($validate, '.')) {
                // 支持场景
                [$validate, $scene] = explode('.', $validate);
            }
            $class = false !== strpos($validate, '\\') ? $validate : $this->app->parseClass('validate', $validate);
            $v     = new $class();
            if (!empty($scene)) {
                $v->scene($scene);
            }
        }
        $v->message($message);
        // 是否批量验证
        if ($batch || $this->batchValidate) {
            $v->batch(true);
        }
        return $v->failException(true)->check($data);
    }
	// 重写__call部分
    public function __call(string $name, array $arguments)
    {
        // TODO: Implement __call() method.
        return show(config("status.action_not_found"),"找不到{$name}方法",null,404);
    }
}

在这里插入图片描述

4.在控制器下面新建Error控制器,然后添加__call方法

在控制器下面新建Error控制器,然后添加__call方法,这样就会调用不存在的控制器的时候会调用__call方法,会传入请求的控制器名称和参数

<?php
namespace app\index\controller;
class Error{
    public function __call(string $name, array $arguments)
    {
        // TODO: Implement __call() method.
        return show(config("status.controller_not_found"),"找不到{$name}控制器",null,404);
    }
}

测试

在这里插入图片描述

在这里插入图片描述

假定一个成功的请求,测试一下

public function jsonTest(){
    $data = ['name' => 'thinkphp', 'status' => '1'];
    return show(config("status.success"),"请求成功",$data);
}

在这里插入图片描述

到此这篇关于ThinkPHP 通用的API格式封装的文章就介绍到这了,更多相关ThinkPHP  API格式封装内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • PHP Cookei记录用户历史浏览信息的代码

    PHP Cookei记录用户历史浏览信息的代码

    购物类网站有时候需要了解用户最近的需求,收集和推送用户的查看记录成为了大部分此类的网站不可缺少的功能,下面是本人在开发项目中自己写的方法,一来留有保存,二来和大家分享
    2016-02-02
  • php自动加载代码实例详解

    php自动加载代码实例详解

    这篇文章主要介绍了php自动加载代码实例详解,文中代码讲解的很清晰,有感兴趣的同学可以研究下
    2021-02-02
  • Laravel学习教程之广播模块详解

    Laravel学习教程之广播模块详解

    这篇文章主要给大家介绍了关于Laravel学习教程之广播模块的相关资料,广播是指发送方发送一条消息,订阅频道的各个接收方都能及时收到消息,文中通过示例代码介绍的非常详细,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-08-08
  • 快速开发一个PHP扩展图文教程

    快速开发一个PHP扩展图文教程

    作者:heiyeluren本文通过非常快速的方式讲解了如何制作一个PHP 5.2 环境的扩展(PHP Extension),希望能够在图文的方式下让想快速学习的朋友了解一下制作过程。
    2008-12-12
  • Yii2中的场景(scenario)和验证规则(rule)详解

    Yii2中的场景(scenario)和验证规则(rule)详解

    Yii2的rule用于对模型属性进行验证,scenario用户定义不同场景下需要验证的模型,下面这篇文章主要给大家介绍了关于Yii2中场景(scenario)和验证规则(rule)的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下。
    2018-01-01
  • php文件上传类的分享

    php文件上传类的分享

    这篇文章主要为大家分享了php文件上传类的相关代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07
  • thinkphp5.1框架模板赋值与变量输出示例

    thinkphp5.1框架模板赋值与变量输出示例

    这篇文章主要介绍了thinkphp5.1框架模板赋值与变量输出,结合实例形式分析了thinkphp5.1框架模板赋值与变量输出基本操作技巧及相关注意事项,需要的朋友可以参考下
    2020-05-05
  • PHP文件系统管理(实例讲解)

    PHP文件系统管理(实例讲解)

    下面小编就为大家带来一篇PHP文件系统管理(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • Laravel路由设定和子路由设定实例分析

    Laravel路由设定和子路由设定实例分析

    这篇文章主要介绍了Laravel路由设定和子路由设定方法,结合实例形式分析了Laravel路由的设定技巧,需要的朋友可以参考下
    2016-03-03
  • thinkphp实现图片上传功能分享

    thinkphp实现图片上传功能分享

    图片上传在网站里是很常用的功能.ThinkPHP里也有自带的图片上传类(UploadFile.class.php) 和图片模型类(Image.class.php)。方便于我们去实现图片上传功能,下面是实现方法
    2014-03-03

最新评论