上一章 文档首页 下一章


片刻之欢愉,不如须臾之宁静。

1.3.1 在线体验

//默认的接口服务
http://demo.phalapi.net/
{
    "ret": 200,
    "data": {
        "title": "Hello World!",
        "content": "PHPer您好,欢迎使用PhalApi!",
        "version": "1.2.0",
        "time": 1443278491
    },
    "msg": ""
}

//带参数的示例接口
http://demo.phalapi.net/?service=Default.Index&username=oschina
{
    "ret": 200,
    "data": {
        "title": "Hello World!",
        "content": "oschina您好,欢迎使用PhalApi!",
        "version": "1.2.0",
        "time": 1443278475
    },
    "msg": ""
}

//故意请求一个非法的服务
http://demo.phalapi.net/?service=Demo.None
{
    "ret": 400,
    "data": [],
    "msg": "非法请求:服务Demo.None不存在"
}

1.3.2 在线接口调试

这里说的接口调试,更多是针对接口调用过程中所执行的SQL语句查看,如:

//带&__sql__=1可打印SQL语句
http://demo.phalapi.net/?service=User.getMultiBaseInfo&user_ids=1,2,3&__sql__=1

返回:
[1 - 0.00032s]SELECT * FROM tbl_user WHERE (id = ?); -- 1
[2 - 0.00019s]SELECT * FROM tbl_user WHERE (id = ?); -- 2
[3 - 0.00016s]SELECT * FROM tbl_user WHERE (id = ?); -- 3
{"ret":200,"data":{"code":0,"msg":"","list":[{"id":"1","name":"dogstar","note":"oschina"},{"id":"2","name":"aevit","note":"fami"},{"id":"3","name":"test","note":"phalapi"}]},"msg":""}

1.3.3 [酷!]接口参数在线查询

为了方便客户端查看最新的接口参数,特别提供此在线工具,根据接口代码实时生成接口参数报表,完全不需要后台开发编写维护额外的文档。我觉得,这很符合敏捷开发之道。

//接口参数在线查询工具链接
http://demo.phalapi.net/checkApiParams.php

如:http://demo.phalapi.net/checkApiParams.php ,访问效果如下:

mahua

因此,接口所需要的参数,对于接口开发人员,也只是简单配置一下参数规则,便可以轻松获取。
关于具体的参数规则配置和接口结果返回格式定义,后期会详细讲到。


上一章 文档首页 下一章