YII框架的RESTful API是什么？YII框架如何开发API？

星降

发布时间：2025-08-01 19:40:02

473人浏览过

来源于php中文网

原创

yii框架通过继承yii\rest\controller类并结合mvc架构实现restful api，支持get、post、put、delete等http方法操作资源；2. 身份验证可使用jwt或oauth 2.0，授权则通过rbac机制控制角色和权限；3. 版本控制可通过uri（如/v1/articles）、请求头或查询参数实现，并在urlmanager中配置路由规则；4. 测试可通过codeception进行单元测试和功能测试，验证api行为并确保质量。

YII框架的RESTful API是什么？YII框架如何开发API？

YII框架的RESTful API，简单来说，就是利用YII框架提供的工具和规范，构建符合RESTful架构风格的应用程序接口，让你的应用程序能够方便地与其他系统进行数据交互。开发API的过程，就是定义资源、设计URI、实现HTTP方法的过程，让你的应用可以被其他应用调用，获取或修改数据。

解决方案

YII框架提供了强大的工具来简化RESTful API的开发。它遵循了模型-视图-控制器（MVC）架构，这使得API的构建过程更加结构化和可维护。

首先，你需要定义你的资源。资源是API的核心，它代表了你要公开的数据。例如，如果你正在构建一个博客API，那么你的资源可能包括“文章”、“用户”和“评论”。

其次，你需要设计URI。URI（统一资源标识符）是资源的地址。好的URI设计应该清晰、简洁、易于理解。例如，

/articles

可以用来获取所有文章，

/articles/{id}

可以用来获取特定ID的文章。

然后，你需要实现HTTP方法。HTTP方法定义了你可以对资源执行的操作。常见的HTTP方法包括：

GET：获取资源
POST：创建资源
PUT：更新资源
DELETE：删除资源

YII框架提供了

yii\rest\Controller

类，你可以继承它来快速构建RESTful API控制器。这个类已经实现了常用的HTTP方法，你只需要重写相应的方法来处理你的业务逻辑。

例如，要创建一个处理文章的API控制器，你可以这样做：

namespace app\controllers;

use yii\rest\Controller;
use app\models\Article;
use yii\web\NotFoundHttpException;

class ArticleController extends Controller
{
    public function actionIndex()
    {
        return Article::find()->all();
    }

    public function actionView($id)
    {
        $model = Article::findOne($id);
        if ($model === null) {
            throw new NotFoundHttpException("Article not found.");
        }
        return $model;
    }

    public function actionCreate()
    {
        $model = new Article();
        $model->load(\Yii::$app->getRequest()->getBodyParams(), '');

        if ($model->save()) {
            \Yii::$app->getResponse()->setStatusCode(201);
            return $model;
        } else {
            return $model->getErrors();
        }
    }

    public function actionUpdate($id)
    {
        $model = Article::findOne($id);
        if ($model === null) {
            throw new NotFoundHttpException("Article not found.");
        }

        $model->load(\Yii::$app->getRequest()->getBodyParams(), '');
        if ($model->save()) {
            return $model;
        } else {
            return $model->getErrors();
        }
    }

    public function actionDelete($id)
    {
        $model = Article::findOne($id);
        if ($model === null) {
            throw new NotFoundHttpException("Article not found.");
        }

        if ($model->delete()) {
            \Yii::$app->getResponse()->setStatusCode(204);
            return;
        } else {
            return $model->getErrors();
        }
    }
}

这个例子展示了如何使用

yii\rest\Controller

来创建一个基本的RESTful API控制器。

actionIndex()

方法用于获取所有文章，

actionView()

方法用于获取特定ID的文章，

actionCreate()

方法用于创建文章，

actionUpdate()

方法用于更新文章，

actionDelete()

方法用于删除文章。

当然，这只是一个简单的例子。在实际开发中，你可能需要处理更复杂的情况，例如身份验证、授权、数据验证等等。YII框架提供了丰富的组件和扩展来帮助你处理这些问题。

YII的配置也是关键。在你的

config/web.php

文件中，你需要配置

urlManager

组件来启用RESTful API路由。例如：

'components' => [
    'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => 'article'],
        ],
    ],
],

这个配置告诉YII框架，所有以

/article

开头的请求都应该由

ArticleController

处理。

RESTful API的开发并非一蹴而就，需要不断的实践和学习。YII框架提供的工具和规范可以帮助你快速入门，但真正的掌握还需要你在实际项目中不断摸索。

如何处理YII框架RESTful API的身份验证和授权？

身份验证和授权是RESTful API安全性的重要组成部分。YII框架提供了多种方式来处理身份验证和授权。

最常见的方法是使用JSON Web Tokens (JWT)。JWT是一种轻量级的、自包含的令牌，可以安全地在客户端和服务器之间传递用户信息。

你可以使用YII的扩展来生成和验证JWT。例如，你可以使用

lhm1/yii2-rest-jwt

扩展。

安装：

composer require lhm1/yii2-rest-jwt

配置：

'components' => [
    'user' => [
        'identityClass' => 'app\models\User',
        'enableAutoLogin' => false,
        'enableSession' => false,
    ],
    'jwt' => [
        'class' => 'lhm1\jwt\Jwt',
        'key' => 'your-secret-key',
    ],
],

使用：

use Yii;
use lhm1\jwt\Jwt;

// 生成JWT
$jwt = Yii::$app->jwt->encode(['uid' => 123]);

// 验证JWT
$payload = Yii::$app->jwt->decode($jwt);

// 或者，在控制器中使用behaviors
public function behaviors()
{
    return [
        'authenticator' => [
            'class' => \yii\filters\auth\HttpBearerAuth::class,
        ],
    ];
}

另一种方法是使用OAuth 2.0。OAuth 2.0是一种授权框架，允许第三方应用程序代表用户访问资源，而无需获取用户的密码。

你可以使用YII的扩展来实现OAuth 2.0服务器。例如，你可以使用

mongosoft/yii2-oauth2-server

扩展。

除了JWT和OAuth 2.0，你还可以使用其他的身份验证和授权机制，例如Basic Authentication、API Keys等等。选择哪种机制取决于你的具体需求。

授权方面，YII框架提供了基于角色的访问控制（RBAC）机制。你可以使用RBAC来定义用户的角色和权限，并根据用户的角色来控制他们对资源的访问。

例如，你可以定义一个“管理员”角色，该角色拥有所有权限，以及一个“普通用户”角色，该角色只能访问部分资源。

魔法映像企业网站管理系统

技术上面应用了三层结构，AJAX框架，URL重写等基础的开发。并用了动软的代码生成器及数据访问类，加进了一些自己用到的小功能，算是整理了一些自己的操作类。系统设计上面说不出用什么模式，大体设计是后台分两级分类，设置好一级之后，再设置二级并选择栏目类型，如内容，列表，上传文件，新窗口等。这样就可以生成无限多个二级分类，也就是网站栏目。对于扩展性来说，如果有新的需求可以直接加一个栏目类型并新加功能操作

下载

use Yii;

// 获取权限管理器
$auth = Yii::$app->authManager;

// 添加角色
$admin = $auth->createRole('admin');
$auth->add($admin);

$user = $auth->createRole('user');
$auth->add($user);

// 添加权限
$createPost = $auth->createPermission('createPost');
$createPost->description = 'Create a post';
$auth->add($createPost);

// 将权限分配给角色
$auth->addChild($admin, $createPost);

// 将角色分配给用户
$auth->assign($admin, 1); // 将admin角色分配给ID为1的用户

然后，你可以在你的控制器中使用RBAC来控制用户的访问。

public function behaviors()
{
    return [
        'access' => [
            'class' => \yii\filters\AccessControl::class,
            'rules' => [
                [
                    'allow' => true,
                    'actions' => ['create'],
                    'roles' => ['createPost'],
                ],
            ],
        ],
    ];
}

如何处理YII框架RESTful API的版本控制？

API版本控制是确保API向后兼容性的重要手段。当你的API发生重大变更时，你应该创建一个新的API版本，以便现有的客户端可以继续使用旧版本的API，而新的客户端可以使用新版本的API。

YII框架提供了多种方式来处理API版本控制。

最常见的方法是使用URI版本控制。URI版本控制是指在URI中包含API版本号。例如：

```
/v1/articles
```
```
/v2/articles
```

你可以使用YII的

urlManager

组件来配置API路由，以便将不同的URI映射到不同的控制器。

'components' => [
    'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => 'v1/article'],
            ['class' => 'yii\rest\UrlRule', 'controller' => 'v2/article'],
        ],
    ],
],

在这个配置中，

/v1/articles

路由映射到

app\controllers\v1\ArticleController

，

/v2/articles

路由映射到

app\controllers\v2\ArticleController

。

另一种方法是使用请求头版本控制。请求头版本控制是指在请求头中包含API版本号。例如：

Accept: application/vnd.example.v1+json

你可以使用YII的

request

组件来获取请求头中的API版本号，并根据版本号来选择不同的控制器或模型。

$version = Yii::$app->request->headers->get('Accept');
if (strpos($version, 'vnd.example.v2') !== false) {
    // 使用v2版本的控制器或模型
} else {
    // 使用v1版本的控制器或模型
}

还有一种方法是使用查询参数版本控制。查询参数版本控制是指在查询参数中包含API版本号。例如：

/articles?version=2

你可以使用YII的

request

组件来获取查询参数中的API版本号，并根据版本号来选择不同的控制器或模型。

$version = Yii::$app->request->get('version');
if ($version == 2) {
    // 使用v2版本的控制器或模型
} else {
    // 使用v1版本的控制器或模型
}

选择哪种版本控制方法取决于你的具体需求。URI版本控制是最常见的，因为它清晰、易于理解。请求头版本控制和查询参数版本控制则更加灵活，但可能不太直观。

无论你选择哪种版本控制方法，都应该确保你的API文档清晰地说明了如何使用不同的API版本。

如何对YII框架RESTful API进行测试？

测试是确保API质量的关键步骤。YII框架提供了多种工具来帮助你测试RESTful API。

单元测试：单元测试用于测试API的单个组件，例如控制器、模型等等。你可以使用YII的

Codeception

框架来编写单元测试。

./vendor/bin/codecept generate:test unit Article

这个命令会创建一个

tests/unit/ArticleTest.php

文件，你可以在这个文件中编写你的单元测试。

例如：

<?php
namespace tests\unit;

use app\models\Article;

class ArticleTest extends \Codeception\Test\Unit
{
    /**
     * @var \UnitTester
     */
    protected $tester;

    protected function _before()
    {
    }

    protected function _after()
    {
    }

    // tests
    public function testCreateArticle()
    {
        $article = new Article();
        $article->title = 'Test Article';
        $article->content = 'This is a test article.';
        $article->status = Article::STATUS_ACTIVE;

        $this->assertTrue($article->save());
        $this->assertNotNull($article->id);
    }
}

功能测试：功能测试用于测试API的整个功能，例如创建文章、获取文章列表等等。你可以使用YII的

Codeception

框架来编写功能测试。

./vendor/bin/codecept generate:test functional Article

这个命令会创建一个

tests/functional/ArticleTest.php

文件，你可以在这个文件中编写你的功能测试。

例如：

<?php
namespace tests\functional;

use Codeception\Util\HttpCode;

class ArticleTest extends \Codeception\Test\Cest
{
    public function _before(\FunctionalTester $I)
    {
        $I->haveHttpHeader('Content-Type', 'application/json');
        $I->haveHttpHeader('Accept', 'application/json');
    }

    public function tryToTestCreateArticle(\FunctionalTester $I)
    {
        $I->sendPOST('/articles', [
            'title' => 'Test Article',
            'content' => 'This is a test article.',
        ]);
        $I->seeResponseCodeIs(HttpCode::CREATED);
        $I->seeResponseIsJson();
        $I->seeResponseContainsJson(['title' => 'Test Article']);
    }
}

API测试：API测试是一种特殊的功能测试，用于测试API的接口。你可以使用