Yii RESTful APIs实战
控制器类是扩展自 yii\rest\ActiveController 类,该类实现了常见的RESTful操作。我们指定 $modelClass 属性,以便控制器知道要使用哪个模型来操作数据。
步骤1 - 在controllers文件夹下创建一个名为 UserController.php 的文件。
接下来,我们需要设置urlManager组件,这样用户数据就能通过有意义的HTTP谓词和友好的URL访问和操作。为了让API以JSON格式访问数据,我们应该配置应用程序组件 request 的parsers属性。
步骤2 - 修改 config/web.php 文件如下:
以最小的努力,我们刚刚建立了一个用于访问用户数据的RESTful API。这些API包括 –
- GET /users - 按页列出所有用户
-
HEAD /users - 显示用户列表的总览信息
-
POST /users - 创建一个新用户
-
GET /users/20 - 返回用户20的详细信息
-
HEAD /users/20 - 显示用户20的总览信息
-
PATCH /users/20 and PUT /users/20 - 更新用户20
-
DELETE /users/20 - 删除用户20
-
OPTIONS /users - 显示与端点/users相关的支持的动词
-
OPTIONS /users/20 - 显示与端点/users/20相关的支持的动词
请注意,Yii会自动将控制器名称变成复数形式。
步骤3 - 现在,打开Postman,输入 http://localhost:8080/users ,然后点击“发送”。您将看到以下内容。
步骤4 − 要创建新用户,将请求类型更改为POST,添加两个请求参数:姓名和电子邮件,并点击“发送”。
步骤5 − 您可以使用 fields 参数来指定在结果中应包含哪些字段。例如,URL http://localhost:8080/users?fields=id ,name 只会返回 id 和 name 字段,如下所示的屏幕截图。