1.2 PhalApi 2.x 运行Hello World

运行Hello World

此文章假设你已成功安装PhalApi2项目，如果尚未安装，可阅读下载与安装。

编写一个接口

在PhalApi 2.x 版本中，项目源代码放置在/path/to/PhalApi2/src目录中。里面各个命名空间对应一个子目录，默认命名空间是app，里面主要有Api、Domain、Model这三个目录以及存放函数的functions.php文件。例如像是这样的目录结构：

./src/
└── app
    ├── Api
    ├── Domain
    ├── functions.php
    └── Model

当需要新增一个接口时，先要在Api层添加一个新的接口文件。例如对于Hello World示例，可以使用你喜欢的编辑器创建一个./src/app/Api/Hello.php文件，并在里面放置以下代码。

// 文件 ./src/app/Api/Hello.php
<?php
namespace App\Api;


use PhalApi\Api;


class Hello extends Api {


    public function world() {
        return array('title' => 'Hello World!');
    }
}

编写接口时，需要特别注意：

• 1、默认所在命名空间必须为App\Api。
• 2、具体实现的接口类必须是PhalApi\Api的子类。

访问一个接口

通常情况下，建议可访问的根路径设为/path/to/PhalApi2/public。若未设置，此时接口访问的URL格式为：接口域名/public/?s=Namespace.Class.Action。其中，s参数用于指定待请求的接口服务，由三部分组成。分别是：

组成部分	是否必须	默认值	说明
Namespace	可选	App	Api命名空间前缀，多级命名空间时用下划线分割
Class	必须	无	待请求的接口类名，通常首字母大写
Action	必须	无	待请求的接口类方法名，通常首字母大写。若Class和Action均未指定时，默认为Site.Index

温馨提示：s参数为service参数的缩写，即使用?s=Class.Action等效于?service=Class.Action，两者都存在时优先使用service参数。

例如，上面新增的Hello World接口的访问链接为：

http://dev.phalapi.net/?s=Hello.World

或者可以使用完整的写法，带上命名空间App：

http://dev.phalapi.net/?s=App.Hello.World

接口返回

默认情况下，接口的结果以JSON格式返回，并且返回的顶级字段有状态码ret、业务数据data，和错误提示信息msg。其中data字段对应接口类方法返回的结果。如Hello Wolrd示例中，返回的结果是：

{"ret":200,"data":{"title":"Hello World!"},"msg":""}

JSON可视化后是：

{
    "ret": 200,
    "data": {
        "title": "Hello World!"
    },
    "msg": ""
}

恭喜！你已顺便完成PhalApi 2.x 简单的接口开发了！