使用thinkphp6搭建后端api接口流程

这个业务逻辑多少都有点奇怪了，阅读浏览次数增值在新闻详情页的控制器方法里setInc，这怎么还写进模型事件里了。如果非要用onAfterRead也可以，把新闻文章的内容单独分出来一个news_content表，然后把它和news做关联，然后给news_content表的onAfterRead事件做增值处理，这样点进新闻页内查询到文章内容时才会触发它。: 评 TP6模型事件-查询后onAfterRead不好用

文章标签更多

ThinkPHP (260)

Mysql (59)

DedeCms (33)

jQuery (74)

证件照 (1)

尺寸大小 (2)

背景颜色 (1)

setInc (4)

setDec (4)

onclick (5)

友情链接更多

超纯水设备

免费设计

海报设计

快递查询

ThinkPHP api接口

打开边栏(ESC) 关闭边栏(ESC)

1、下载tp6

首先搭建wamp,或lamp的环境安装composer，通过composer安装tp6,thinkphp官网已经不再支持直接下载。

composer create-project topthink/think tp6

如果安装当前目录

composer create-project topthink/think .

2、打开错误调试

找到根目录下的.example.env文件，重命名此文件，把.example删掉
查看里面的代码，会发现，它打开了app_debug调试。

但是当我们apipost/postman调用接口的时候，会发现接口下面多出很多thinkphp的调试信息，

所以把app_debug=false关掉调试模式。

但是如果出错了，看不到错误信息，怎么办？
找到config/app.php下的show_error_msg ,改成true，这样可以简单的看见错误信息

// 显示错误信息
'show_error_msg'   => true,

3、隐藏入口文件

实现隐藏index.php很简单，只需要找到public目录下的.htaccess文件，添加如下代码就可以了。
Apache版本：

<IfModule mod_rewrite.c>
  Options +FollowSymlinks -Multiviews
  RewriteEngine On

  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteCond %{REQUEST_FILENAME} !-f
  #RewriteRule ^(.*)$ index.php/$1 [QSA,PT,L] #这个有点问题，不用
  RewriteRule ^(.*)$ index.php [L,E=PATH_INFO:$1] #用这个
</IfModule>

Nginx版本：

location / {
  if (!-e $request_filename) {
    rewrite  ^(.*)$  /index.php?s=/$1  last;
  }
}

4、解决跨域问题
在应用开发中，前后端都是分开独立开发的，而前后端通常都会自己搭建一个web服务，运行在不同的端口上，在前端访问后端的接口时，会报跨域的错误。而这种跨域问题通常是要有后端来处理的，tp6有专门的中间件来做这个事情，真是太方便了，只需要在app目录下的middleware.php中添加该中间件，就实现了跨域访问。

<?php
// 全局中间件定义文件
return [
    // 全局请求缓存
    // \think\middleware\CheckRequestCache::class,
    // 多语言加载
    // \think\middleware\LoadLangPack::class,
    // Session初始化
    // \think\middleware\SessionInit::class,
    // 跨域解决
    \think\middleware\AllowCrossDomain::class,
];

5、路由解决api版本控制
在app目录中的container控制器中新建两个文件夹v1,v2,在其中都创建User.php文件

命令：

php think make:controller v1/Blog2 --plain

v1/User.php

from clipboard

v2/User.php

from clipboard

注意上面两个文件的命名空间，就第一行代码，在哪个文件夹下，就写到哪里。
现在方法有了，我们还无法访问，需要使用路由，让路由帮我们找对应的方法。

至于路由的概念去文档自己看。我这里主要用路由组的方式，我觉得这个比资源路由好用，灵活。

在根目录下的route目录下的app.php文件代码如下：

use think\facade\Route;

// api版本控制
$v = request()->header('Api-Version');
// 默认api版本为v1
if ($v == null) {
    $v = 'v1';
}
Route::group('user', function () {
    Route::post('login', 'login');
})->prefix($v.'.user/')->pattern(['id' => 'd+']);

以上代码进行控制api版本的方式是，请求发起者在header中传递要访问的api的版本，这里获取到对应的版本，访问对应的方法。

鉴于以上我使用的是post请求，且要传递header，所以使用ApiPost / postman进行测试。
访问v1版本的接口时：
from clipboard

访问v12版本的接口时：

from clipboard

6、jwt token验证
thinkphp常用的扩展插件请参考：http://sites.thinkphp.cn/1556332

composer require thans/tp-jwt-auth

安装完成后，该插件所在的位置在根目录下的vendor/thans/tp-jwt-auth
还会在根目录下的config目录下生成jwt.php文件来记录一些配置信息
from clipboard

看这里都是读取的env中的参数，所以咱也在根目录下的.env文件中配置参数。
在根目录下打开cmd窗口,执行

php think jwt:create

会帮你在.env文件中生成密钥secret,红色框中的是新增的内容

from clipboard

token的有效期为60秒，为了方便我们测试，我就不改了，如果你要改，可以在.env中添加，这样就改成了半小时

from clipboard

这个插件有三种方式【header,token,param】传递token，我就使用其中一个，也是最常用的一种，就是在【header】中传递token信息，这个插件默认验证header中的token信息需要传递的参数名为authorization,而在header中直接传递该参数tp6是获取不到的，需要做一些设置，
在根目录中的public目录下的.htacccess文件中添加（Nginx好像不需要添加也能正常获取到Authorization）

SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0

那么现在开始测试：
(1).生成token
我就在之前创建的v1/User.php控制器中写了

<?php
namespace app\controller\v1;
use app\BaseController;
use thans\jwt\facade\JWTAuth;

class User extends BaseController {
    public function login() {
        $token = JWTAuth::builder(['uid' => 1, 'name' => '测试1']);
        return $token;
    }
}

(2).验证token
我使用的是路由中间件的方式验证token，
① 写一个中间件
在根目录下的app目录中创建middleware目录，在其下创建CheckToken.php文件
app/middleware/CheckToken.php

也可以用命令创建：

php think make:middleware CheckToken

<?php
namespace app\middleware;

use thans\jwt\exception\JWTException;
use thans\jwt\facade\JWTAuth;

class CheckToken {
    public function handle($request, \Closure $next) {
        // OPTIONS请求直接返回
        if ($request->isOptions()){
            return response();
        }
        try {
            JWTAuth::auth();
        }catch (JWTException $e){
            return json($e->getMessage());
        }
        return $next($request);
    }
}

② 起别名
给该中间件起个别名，在根目录下的config/middleware.php文件中

<?php
// 中间件配置
return [
    // 别名或分组
    'alias'    => [
        'CheckToken' => app\middleware\CheckToken::class
    ],
    // 优先级设置，此数组中的中间件会按照数组中的顺序优先执行
    'priority' => [],
];

③ 在路由文件中使用中间件 route/app.php

Route::group('user', function () {
    Route::post('login', 'login');
    Route::post('userInfo', 'getUserInfo')->middleware('CheckToken');
})->prefix($v.'.user/')->pattern(['id' => 'd+']);

④ 创建对应的方法
在第三步中我们创建了一个getUserInfo()方法，现在在User.php文件中创建

public function getUserInfo() {
   return json(['id'=>1, 'name'=> '啦啦啦']);
}

⑤ 验证一下
刚刚创建的token必然过期了，咱重新获取一条http://tp.cn:8083/user/login
现在验证一下http://tp.cn:8083/user/userinfo

请求userinfo方法，并在header中添加参数Authorization，
注意：token值需要加上bearer ，bearer后的空格也要的。
from clipboard

from clipboard

可以看到token验证提示，该通过过期了，这个插件成功了，并没有继续往下走，把之前的信息返回。

(3).刷新token，会将旧token加入黑名单
JWTAuth::refresh();//刷新token，会将旧token加入黑名单

(4).注销或拉黑token
JWTAuth::invalidate($token);
这个拉黑的具体操作就是把你要注销的token保存在本地的cookie中，默认的保存时间是14天，14天后cookie会自己删除的，你可以在根目录下的runtime目录下的cache目录中找到对应的文件，我就不测试这个方法了，我感觉这个操作好像没什么必要。

(5).验证Token是否为黑名单
JWTAuth::validate($token);

7、统一的参数返回形式
实际开发中，后端返回给前端的参数往往都是这样的。
from clipboard

所以我们需要对参数返回形式做个统一的处理
在app目录下的common.php中定义的方法全局都可调用，所以在这个文件中定义此方法。

<?php
use think\Response;

// 应用公共文件
// 统一返回数据格式
function result($data = [], string $msg = 'error', int $code = 200, string $type = 'json') {
    $result = [
        'code' => $code,
        'msg' => $msg,
        'data' => $data
    ];
    // 调用Response的create方法，指定code可以改变请求的返回状态码
    return Response::create($result, $type)->code($code);
}

哪里用的时候直接调用即可
以下为常用状态码：
200 请求成功
204 请求成功,未返回实体，比如option请求
400 错误的请求
401 认证失败，这个一般在token验证那里
403 拒绝访问
404 请求的资源不存在
413 请求实体太大
422 参数验证错误

500 服务器错误

8、异常捕捉
tp6异常捕获 https://www.kancloud.cn/manual/thinkphp6_0/1037615
没太懂，就不复制了，需要的可以参考原博主https://blog.csdn.net/donglianyou/article/details/124301837

9、自动生成api文档
（1）安装插件 https://hgthecode.github.io/thinkphp-apidoc/guide/install/

composer require hg/apidoc

（2）下载对应的前端页面
请根据你安装的apidoc版本点击下载对应的前端文件

请根据你安装的apidoc版本点击下载对应的前端文件

Apidoc版本 Github Gitee（国内推荐）
v3.1.0 - v3.1.5 v2.1.3 v2.1.3
v3.0.0 - v3.0.8 v2.0.11 v2.0.11
下载完成后解压，将apidoc文件夹拷贝到你的项目 public 目录下
打开浏览器访问 http://你的域名/apidoc/ ，出现接口文档页面，表示安装成功。

（3）使用
具体配置你还得看文档，我就直接照着最简单的做了，
我就试一个，将app/controller/v1/User.php写了注释，它会读注释生成接口文档

① 引入注释
app/controller/v1/User.php

原博主注释是@ApidocTitle("V1")访问http://你的域名/apidoc/有错误，改成@Apidoc\Title("V1")可以正常了

<?php

namespace app\controller\v1;
use app\BaseController;
use thans\jwt\facade\JWTAuth;
use app\validate\User as UserValidate;
// 添加这句，注释写法为 @Apidoc参数名(...)
use hg\apidoc\annotation as Apidoc;

/**
 * @Apidoc\Title("V1")
 * @Apidoc\Group("base")
 */
class User extends BaseController {
    /**
     * @Apidoc\Title("登录")
     * @Apidoc\Url("v1.user/login")
     * @Apidoc\Tag("测试 基础")
     * @Apidoc\Param("username", type="string",require=true, desc="用户名" )
     * @Apidoc\Param("password", type="string",require=true, desc="密码" )
     * @Apidoc\Returned("id", type="int", desc="新增用户的id")
     */
    public function login() {
        //数据验证,batch开启批量验证
        validate(UserValidate::class)->batch(true)->check([
            'name' => 'dongsir',
            'email' => 'dongsir@qq.com'
        ]);
        return result(null, '成功', 200);
    }
}

关于这个多应用/多版本的配置项，去apidoc的文档去看吧，在config/apidoc.php修改apps的配置就可以了，然后就可以通过右上角的选择框切换版本了
// 设置应用/版本（必须设置）

'apps'           => [
        [
            'title'=>'演示示例',
            'path'=>'app',
            'folder'=>'controller',
            'items'=>[
                ['title'=>'V1.0','path'=>'appcontroller1','folder'=>'v1'],
                ['title'=>'V2.0','path'=>'appcontroller2','folder'=>'v2']
            ]
        ],
    ],

赏

前一篇

tp6路由规则<id>

后一篇

“最难不过坚持”

本人承接扒站仿站，php网站维护，病毒查杀，网站编辑，网站改版，html制作

tp6路由规则<id>

thinkphp6 整合PhpSpreadsheet 导出数...