广告：宝塔Linux面板高效运维的服务器管理软件 点击【 https://www.bt.cn/p/uNLv1L 】立即购买

本篇文章给大家带来了关于thinkphp的相关知识，其中主要介绍了关于怎样搭建后端api接口的相关问题，包括了隐藏入口文件、解决跨域问题以及异常捕捉等等相关方面，希望对大家有帮助。

推荐学习：《thinkphp框架》

这段时间学习了一下简单搭建一个api接口后端服务，现在记录一下。

我使用的是集成环境phpstuday,安装了composer，通过composer安装tp6,thinkphp官网已经不再支持直接下载。

composer create-project topthink/think tp6

你也可以直接按照tp6看云文档的步骤来安装tp6

在下载好的tp6目录通过cmd命令窗口输入

php think run

在浏览器中输入127.0.0.1:8000，访问到如下页面就安装成功了

在开始之间，我们先打开tp6的错误调试 1.找到config/app.php下的show_error_msg ,改成true 2.找到下面根目录下的.example.env文件，重命名此文件，把.example删掉 查看这里面的代码，会发现，它打开了app_debug调试 这样我们就能看到完整的报错信息了，例如：

在第1节中，我们访问

http://127.0.0.1:8000

实际访问的是

http://127.0.0.1:8000/index.php/index/index

你也可以通过这样的方式访问

http://127.0.0.1:8000/index/index

如果什么都不填，默认访问的就是index控制器，在config/app.php文件中有这样的定义，你也可以修改默认的控制器 还有，不管访问任何控制器，如果没有填方法，它都会访问控制器中的index方法，如果index方法不存在，则提示错误信息-方法不存在。 通过在项目根目录中运行的php think run开启的web服务，tp6帮我们做了隐藏入口文件的操作，所以你可以通过第三种方式访问。但是我们这一节要说的就是隐藏入口，怎么能用tp6自带的web服务呢。所以要自己来。 我们在开发时，往往会在本地搭建WNMP等这样的一套web解决方案，这就需要我们自己去隐藏入口文件index.php

为什么要隐藏入口文件？

我这里因为用的集成环境，选用的是apache服务器，所以我只找了apache的隐藏入口文件的方法，nginx的需要自己搜索了。 现在我启用apache服务器，开的端口是4321

当我想通过

http://127.0.0.1:4321/index/index

去访问方法时，访问失败 而我加上入口文件访问时，访问成功

http://127.0.0.1:4321/index.php/index/index

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

<IfModule mod_rewrite.c> #如果mode_rewrite.c模块存在 则执行以下命令  Options +FollowSymlinks -Multiviews  RewriteEngine On #开启 rewriteEngine  # !-d 不是目录或目录不存在  RewriteCond %{REQUEST_FILENAME} !-d   # !-f 不是文件或文件不存在  RewriteCond %{REQUEST_FILENAME} !-f   RewriteRule ^(.*)$ index.php [QSA,PT,L]  # 参数解释  # ^(.*)$： 匹配所有的路口映射  # QSA: （Query String Appending）表示保留参数入get传值？xxx==xx;  # PT: 把这个URL交给Apache处理；  # L: 作为最后一条，遇到这条将不再匹配这条之后的规则</IfModule>

现在访问

http://127.0.0.1:4321/index/index

访问成功

需要注意，在第一节中我们看到，运行了php think run 后，我们的项目目录访问的是public目录 官方文档中也说在项目中应该只有public目录是可以被外界访问的，所以如果有什么需要访问的图片、视频等资源，应该放在此目录下

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

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

在app目录中的container控制器中新建两个文件夹v1,v2,在其中都创建User.php文件 v1/User.php

<?phpnamespace app\controller\v1;use app\BaseController;class User extends BaseController{    public function login()    {      return '我是v1';    }}

v2/User.php

<?phpnamespace app\controller\v2;use app\BaseController;class User extends BaseController{    public function login()    {      return '我是v2';    }}

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

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

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

<?php// +----------------------------------------------------------------------// | ThinkPHP [ WE CAN DO IT JUST THINK ]// +----------------------------------------------------------------------// | Copyright (c) 2006~2018 http://thinkphp.cn All rights reserved.// +----------------------------------------------------------------------// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )// +----------------------------------------------------------------------// | Author: liu21st <liu21st@gmail.com>// +----------------------------------------------------------------------use think\facade\Route;// api版本控制$v = request()->header('Api-Version');// 默认api版本为v1if ($v == null) $v = "v1";// 用户Route::group('user', function () {  Route::post('login', 'login');})->prefix($v.'.user/')->pattern(['id' => '\d+']);

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

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

我用的是tp6看云文档收录的插件

composer require thans/tp-jwt-auth

该插件的github地址-文档在开始之前可以看看文档里是怎么操作的，我也是按照文档来的

安装完成后，该插件所在的位置在根目录下的vendor/thans/tp-jwt-auth 还会在根目录下的config目录下生成jwt.php文件来记录一些配置信息 看这里都是读取的env中的参数，所以咱也在根目录下的.env文件中配置参数。 在根目录下打开cmd窗口,执行

php think jwt:create

会帮你在.env文件中生成密钥secret,红色框中的是新增的内容 token的有效期为60秒，为了方便我们测试，我就不改了，如果你要改，可以在.env中添加，这样就改成了1小时 这个插件有三种方式【header,token,param】传递token，我就使用其中一个，也是最常用的一种，就是在【header】中传递token信息，这个插件默认验证header中的token信息需要传递的参数名为authorization,而在header中直接传递该参数tp6是获取不到的，需要做一些设置， 在根目录中的public目录下的.htacccess文件中添加

SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0

那么现在开始测试：

我就在之前创建的v1/User.php控制器中写了

<?phpnamespace app\controller\v1;use app\BaseController;// 引入jwt插件use thans\jwt\facade\JWTAuth;class User extends BaseController{    public function login()    {      // 生成token      $token = JWTAuth::builder(['uid' => 1,'name'=>'ceshi']);      return $token;    }}

在postman中测试

我使用的是路由中间件的方式验证token，

在根目录下的app目录中创建middleware目录，在其下创建CheckToken.php文件app/middleware/CheckToken.php 文件内容

php think run0

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

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

php think run1

刚刚创建的token必然过期了，咱重新获取一条

现在验证一下,请求userinfo方法，并在header中添加参数Authorization，注意：token值需要加上bearer ，bearer后的空格也要的。 过了一分钟后，我们再来试一试 可以看到token验证提示，该通过过期了，这个插件成功了，并没有继续往下走，把之前的信息返回。

这个插件在github中的文档中没有说到怎么注销或删除token,只有一个刷新refresh和拉黑invalidate,我看了一下它的代码，刷新方法中会调用拉黑方法，看到这个注释，让我激动了一下，鸡儿！原来拉黑就是注销 这个拉黑的具体操作就是把你要注销的token保存在本地的cookie中，默认的保存时间是14天，14天后cookie会自己删除的，你可以在根目录下的runtime目录下的cache目录中找到对应的文件，我就不测试这个方法了，我感觉这个操作好像没什么必要。

文件内容形似这样 至此token这节就结束了。

什么？ 你想改默认的token名称？那你可得好好研究这个插件了，看看怎么改，改完了记得踢我一脚，让我也看看，虽然我觉得一个Authorization已经够用了。

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

php think run2

唉，这个时候，经验的重要性就体现出来，我是个前端，而且在我自己看来，还算是个没有工作经验的前端，

调用就很简单了，可以直接使用 我们还是改一下login方法

php think run3

返回结果 这样好像没有体现我们修改的请求的状态码，那我们把$code改成500,再来看看结果如何 咱已经成功的将改请求状态变成了500 得嘞，现在再来回头看看我们之前写的检查jwt的中间件，把返回的结果封装一下 再去验证一下看看，看着返回的结果就舒服多了，这特么才是后端给前端返回的结果。 本小节结束，记录一下一些常见的状态码，我在自己写的时候就只用到了这些状态码

异常捕捉（看云文档）内容挺多的，自己去百度吧，我就把我遇到过的常见的错误进行捕捉，其它的异常我也爱莫能助，不懂啊 !>_>! 我也就不自定义类了，直接在它给的默认的异常处理文件里写了。

我们先写一个参数验证的类，在app目录下创建validate目录，创建User.php文件 app/validate/User.php

php think run4

tp6的异常捕捉分为两种，自动和手动的，手动的就是通过try{}catch{}捕捉。tp6的异常捕捉大多是自动的，不过，比如我们现在要操作的参数验证错误就需要自己去捕捉来抛出异常，我们此节的目的是统一捕捉这个错误，我就不用手动的了。 我们就在异常处理类的render方法中添加这个捕捉抛出就可以了。

php think run5

现在在方法中一下，看看能否捕获。 app/controller/v1/User.php 查看结果，成功被捕获到了，并抛出了错误内容 如果验证通过了，就会正常的走下去，则会显示我return的测试内容

我还没找到方法，在我的预想中这个应该要做到能够准确的反应未匹配到的原因。

php think run6

php think run7

本节结束，这里面用的错误处理都是我在平常练习中遇到的错误，至于其他的没有处理是因为我还没碰到，碰到再说吧。为了给前端好的反馈，我们应该处理所有的异常的返回形式，不然，tp6默认返回页面形式的，前端等于得不到相应了。至于这个自定义异常捕获，应该有相应的插件的吧，你要是感兴趣可以去找找。

之前我还很好奇，后端是怎么搞出接口文档的，都是自己录入数据套模板的吗？原来他么的都是插件做的，真他么方便！！！

php think run8

你就照着插件的文档来就好了，不用跟着我。

下载最新的，放在public目录下

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

app/controller/v1/User.php

php think run9

这个接口文档这里有点小问题，因为我们前面使用在header中添加api版本的方式控制请求的api版本，所以如果直接用/user/login是无法访问到控制器的，也就访问不到方法，必须得加上控制器所在位置的信息，就在前面加上了v1,变成了v1.user/login。这种形式是通过控制器去访问的方法，显然不理想，我想要达到的目标是不需要再里面加上v1，这个还得好好研究研究，不然前面定义的路由不是跟这个接口文档对不上了吗？你们要是研究到了，记得踢我一脚哈 >_>!

#后记：当时只是练习一下我，我也没深究，but其实这个apidoc它的官方文档里有设置项的，关于这个多应用/多版本的配置项，去apidoc的文档去看吧，在config/apidoc.php修改apps的配置就可以了，然后就可以通过右上角的选择框切换版本了

<IfModule mod_rewrite.c> #如果mode_rewrite.c模块存在 则执行以下命令  Options +FollowSymlinks -Multiviews  RewriteEngine On #开启 rewriteEngine  # !-d 不是目录或目录不存在  RewriteCond %{REQUEST_FILENAME} !-d   # !-f 不是文件或文件不存在  RewriteCond %{REQUEST_FILENAME} !-f   RewriteRule ^(.*)$ index.php [QSA,PT,L]  # 参数解释  # ^(.*)$： 匹配所有的路口映射  # QSA: （Query String Appending）表示保留参数入get传值？xxx==xx;  # PT: 把这个URL交给Apache处理；  # L: 作为最后一条，遇到这条将不再匹配这条之后的规则</IfModule>0

一个简单的后端接口这样应该就够用了，以我之前做过的学校的课程设计的经验来说的哈。我没有用过别的后端语言，不过就现在感觉，php真好用，不亏是世界上最好的语言。

推荐学习：《PHP视频教程》

以上就是实例图文详解！thinkphp搭建后端api接口的详细内容，更多请关注9543建站博客其它相关文章！

广告：SSL证书一年128.66元起，点击购买~~~