ThinkPHP接口开发restful api使用总结

涛哥使用环境为thinkphp5.0.10，来开发app后端接口

一、RESTFUL API HTTP状态码

200 请求成功
201 创建成功
202 更新成功
400 无效请求
401 地址不存在
403 禁止访问
404 请求资源不存在
500 内部错误

二、API数据结构格式

status 业务状态码（业务状态码自行约定）
message 提示信息
data 数据层

三、ThinkPHP5 restful api使用方法

通过Route.php资源路由类完成restful

Route::resource('user','api/user');
//涛哥实际项目中使用https://www.phpnote.cc
use think\Route;
Route::domain('api','api');
Route::resource(':ver/user', ':ver.user');

Route::resource('user','api/user');

//涛哥实际项目中使用https://www.phpnote.cc

use think\Route;

Route::domain('api','api');

Route::resource(':ver/user', ':ver.user');

四、ThinkPHP5通用API接口数据输出

function show($status, $message, $data=[], $httpCode=200)
{
    $data = [
        'status'   => $status,
        'message'  => $message,
        'data'     => $data  
    ];
    return json($data,$httpCode);
}

function show($status, $message, $data=[], $httpCode=200)

{

$data = [

'status' => $status,

'message' => $message,

'data' => $data

];

return json($data,$httpCode);

}

五、不可预知的内部异常api数据输出解决方案

http状态码和业务码异常处理

<?php
namespace app\common\exception;

use think\Exception;

class ApiException extends Exception{

    public $message   = '';
    public $httpCode  = 500;
    public $code      = 0;

    public function __construct($message = "", $httpCode = 0, $code = 0)
    {
        $this->message    = $message;
        $this->httpCode   = $httpCode;
        $this->code       = $code;
    }
}

<?php

namespace app\common\exception;

use think\Exception;

class ApiException extends Exception{

public $message = '';

public $httpCode = 500;

public $code = 0;

public function __construct($message = "", $httpCode = 0, $code = 0)

{

$this->message = $message;

$this->httpCode = $httpCode;

$this->code = $code;

}

异常

<?php
namespace app\common\exception;

use think\exception\Handle;

class ApiHandleException extends Handle{

    /**
     * http状态码
     * @var int
     */
    public $httpCode = 500;

    public function render(\Exception $e)
    {
        if(config('app_debug') == true){
            return parent::render($e);
        }

        if($e instanceof ApiException){
            $this->httpCode = $e->httpCode;
        }
        return show(0, $e->getMessage(),[],$this->httpCode);
    }
}