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

1.3.1 在线体验

  1. //默认的接口服务
  2. http://demo.phalapi.net/
  3. {
  4. "ret": 200,
  5. "data": {
  6. "title": "Hello World!",
  7. "content": "PHPer您好,欢迎使用PhalApi!",
  8. "version": "1.2.0",
  9. "time": 1443278491
  10. },
  11. "msg": ""
  12. }
  13. //带参数的示例接口
  14. http://demo.phalapi.net/?service=Default.Index&username=oschina
  15. {
  16. "ret": 200,
  17. "data": {
  18. "title": "Hello World!",
  19. "content": "oschina您好,欢迎使用PhalApi!",
  20. "version": "1.2.0",
  21. "time": 1443278475
  22. },
  23. "msg": ""
  24. }
  25. //故意请求一个非法的服务
  26. http://demo.phalapi.net/?service=Demo.None
  27. {
  28. "ret": 400,
  29. "data": [],
  30. "msg": "非法请求:服务Demo.None不存在"
  31. }

1.3.2 在线接口调试

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

  1. //带&__sql__=1可打印SQL语句
  2. http://demo.phalapi.net/?service=User.getMultiBaseInfo&user_ids=1,2,3&__sql__=1
  3. 返回:
  4. [1 - 0.00032s]SELECT * FROM tbl_user WHERE (id = ?); -- 1
  5. [2 - 0.00019s]SELECT * FROM tbl_user WHERE (id = ?); -- 2
  6. [3 - 0.00016s]SELECT * FROM tbl_user WHERE (id = ?); -- 3
  7. {"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 [酷!]接口参数在线查询

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

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

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

mahua

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

原文: https://www.phalapi.net/wikis/1-3.html