使用Yii2 REST客户端调用自建Yii2 REST API的求助

你已经有一个运行正常的 Yii2 REST API，现在想从另一个 Yii2 站点调用它，并且尝试基于 yiisoft/yii2-authclient 的 Facebook 客户端来改造——这个思路是对的，因为 AuthClient 组件提供了便捷的 HTTP 请求封装，我们只需要针对你的 API 的 Bearer 认证方式做适配即可。下面是具体的步骤：

1. 创建自定义 REST 客户端类 #

首先，我们需要创建一个继承自 yii\authclient\BaseClient 的自定义客户端，适配你的 API 的认证规则和请求格式：

<?php
namespace app\components;

use yii\authclient\BaseClient;
use yii\web\HttpException;

class MyApiClient extends BaseClient
{
    // API 基础地址
    public $baseUrl = 'https://example.com/api/v3';
    // Bearer 令牌
    public $accessToken;

    /**
     * 必须实现的抽象方法（用于 OAuth 类客户端，这里我们不需要，返回空数组即可）
     */
    protected function initUserAttributes()
    {
        return [];
    }

    /**
     * 重写请求创建方法，添加默认请求头和认证信息
     */
    protected function createRequest()
    {
        $request = parent::createRequest();
        // 设置默认接受 JSON 格式响应
        $request->addHeaders(['Accept' => 'application/json']);
        // 添加 Bearer 认证头
        if (!empty($this->accessToken)) {
            $request->addHeaders(['Authorization' => "Bearer {$this->accessToken}"]);
        }
        return $request;
    }

    /**
     * 封装获取用户信息的便捷方法
     */
    public function getUserInfo()
    {
        $response = $this->get('user');
        
        if ($response->isOk) {
            return $response->data; // 自动解析 JSON 响应为数组
        }
        
        // 处理错误响应
        throw new HttpException($response->statusCode, $response->content);
    }
}

2. 在 Yii2 应用中配置客户端 #

打开你的应用配置文件（config/web.php 或 config/main.php），在 components 节点下添加自定义客户端的配置：

'components' => [
    // ... 其他组件配置
    'myApiClient' => [
        'class' => 'app\components\MyApiClient',
        'accessToken' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // 这里填你的有效 Bearer 令牌
        // 如果令牌需要动态获取，可以后续在代码中设置，不必写死在这里
    ],
],

3. 在代码中调用 API 获取数据 #

现在你可以在控制器、组件或任何地方使用这个客户端来调用 API 了，示例代码如下：

use Yii;
use yii\web\Controller;

class ApiController extends Controller
{
    public function actionFetchUser()
    {
        try {
            // 获取客户端实例
            $client = Yii::$app->myApiClient;
            
            // 如果令牌是动态获取的，可以在这里设置
            // $client->accessToken = $this->getDynamicToken();
            
            // 调用 API 获取用户信息
            $userData = $client->getUserInfo();
            
            // 处理返回的数据，比如返回给前端
            return $this->asJson($userData);
        } catch (HttpException $e) {
            // 处理 API 错误，比如令牌过期、权限不足等
            return $this->asJson([
                'code' => $e->statusCode,
                'message' => $e->getMessage()
            ]);
        } catch (\Exception $e) {
            // 处理其他异常
            return $this->asJson([
                'code' => 500,
                'message' => '服务器内部错误'
            ]);
        }
    }
}

4. 扩展与优化建议 #

• 动态令牌管理：如果你的令牌是通过 OAuth2 流程获取的（比如密码授权、客户端凭证授权），可以在客户端类中添加获取和刷新令牌的方法，自动处理令牌过期问题。
• 请求方法扩展：除了 getUserInfo，你可以封装更多方法对应 API 的其他接口（比如 POST 创建资源、PUT 更新资源等）。
• 日志与调试：可以在 createRequest 方法中添加日志记录，方便调试请求和响应细节。
• CORS 处理：如果你的客户端是前端页面发起请求，需要确保 API 服务器配置了正确的 CORS 规则，允许你的域名访问。

常见问题排查 #

• 401 Unauthorized：检查令牌是否有效、是否过期，以及请求头中的 Authorization 格式是否正确（注意 Bearer 和令牌之间有空格）。
• 请求格式错误：确保请求头包含 Accept: application/json，API 可能只返回 JSON 格式响应。
• 连接超时：检查 API 地址是否正确，网络是否可达，或者 API 服务器是否有防火墙限制。

内容的提问来源于stack exchange，提问作者Mr Goobri