×
PhalApi 2.x 前言

PhalApi 2.x 快速开发

1.1 下载与安装1.2 运行Hello World1.3 如何请求接口服务1.4 接口响应与在线调试1.5 Api接口层1.6 Domain领域层和ADM模式1.7 Model数据层与数据库操作1.8 单元测试1.9 自动加载和PSR-41.10 接口文档

PhalApi 2.x 数据库

2.1 数据库链接2.2 数据库与NotORM2.3 数据库使用和查询2.4 数据库分库分表策略2.5 连接多个数据库2.6 打印和保存SQL语句2.7 定制你的Model基类

PhalApi 2.x 高级专题

3.1 PhalApi 2.x 接口参数3.2 PhalApi 2.x 配置3.3 PhalApi 2.x 日志3.4 PhalApi 2.x 缓存3.5 PhalApi 2.x 过滤器3.6 PhalApi 2.x COOKIE3.7 PhalApi 2.x 加密3.8 PhalApi 2.x 国际化3.9 PhalApi 2.x CURL请求3.10 PhalApi 2.x 工具和杂项3.11 PhalApi 2.x DI服务汇总

PhalApi 2.x 发现更多

4.1 PhalApi 2.x 扩展类库4.2 PhalApi 2.x SDK包的使用4.3 PhalApi 2.x 脚本命令

关于PhalApi 2.x

5.1 PhalApi 2.x 版本完美诠释5.2 PhalApi 2.x 升级指南5.3 PhalApi 2.x VS PhalApi 1.x

1.2 PhalApi 2.x 运行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 AppApi;

use PhalApiApi;

class Hello extends Api {

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

编写接口时,需要特别注意:

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

    访问一个接口

    通常情况下,建议可访问的根路径设为/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 简单的接口开发了!


分类导航

关注微信下载离线手册

bootwiki移动版 bootwiki
(群号:472910771)