17、Yii REST API 认证与响应定制全解析

Yii REST API 认证与响应定制全解析

在开发 REST API 时，认证和响应定制是至关重要的环节。认证确保只有授权用户能够访问 API，而响应定制则可以为客户端提供更详细、更有用的信息。本文将详细介绍 Yii 框架中 REST API 的认证方式、新控制器动作的添加、认证和响应的定制方法，并通过具体示例进行说明。

1. 认证方式

1.1 三种认证方式概述

Yii 支持三种主要的认证方式，每种方式都有其适用场景和特点，具体如下：
| 认证方式 | 类名 | 描述 |
| — | — | — |
| HTTP Basic Auth | HttpBasicAuth | 使用 WWW-Authenticate HTTP 头，在每个请求中发送用户名和密码 |
| 查询参数认证 | QueryParamAuth | 在 API URL 中作为查询参数传递访问令牌 |
| OAuth 2 | HttpBearerAuth | 消费者从授权服务器获取访问令牌，并通过 HTTP 承载令牌发送到 API 服务器 |

1.2 启用认证的步骤

要启用认证，需要按照以下三个步骤进行配置：
1. 配置用户应用组件 ：在配置文件中设置 enableSession 为 false ，以确保用户认证状态在请求之间不持久化；将 loginUrl 设置为 null ，以便在认证失败时显示 HTTP 403 错误而不