rockielin/yii2-basic-restful-api-template

使用 Yii2 基本模板的简单 Web API

dev-master 2016-07-17 18:16 UTC

This package is auto-updated.

Last update: 2024-09-06 18:01:53 UTC


README

简单 Web API

使用 POST 或 GET 方法并返回 JSON 响应的基本 Web API

Latest Stable Version Total Downloads

安装

您可以选择以下方法之一安装应用程序。

通过 Composer 安装

如果您没有 Composer,您可以按照 getcomposer.org 上的说明进行安装。

然后,您可以使用以下命令安装应用程序

php composer.phar global require "fxp/composer-asset-plugin:~1.1"
php composer.phar create-project --prefer-dist --stability=dev rockielin/yii2-basic-restful-api-template project-name

启用调试

在 /config/ 目录中创建 "develop.me" 文件

请求

所有请求都使用 POST 或 GET 方法。

使用控制器验证 POST 参数

$this->checkParms(["parm1",
  "parm2",.....]);

响应

成功响应格式

{"data":json object,"status":200}

错误响应格式

{"data":"message","status":status code}

错误输出示例

throw new \yii\web\HttpException(401, "authentication failed!");