「PHP开发APP接口实战004」基础响应参数说明
2018-01-23 本文已影响66人
一念觀心
通过前面4章教程的学习，我们已经完成了APP接口开发环境的搭建工作。
「PHP开发APP接口实战000」项目需求分析说明书
「PHP开发APP接口实战001」开发环境搭建
「PHP开发APP接口实战002」Phalcon入口文件
「PHP开发APP接口实战003」自定义异常处理
示例代码下载
链接：https://pan.baidu.com/s/1sm4fdHb 密码：qj7n
本章主要讲解接口响应参数的基本意义。
基础JSON响应参数说明：
| 参数 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| status | Int | 是 | 状态：1 成功, 2 失败 | 1 |
| value | String | 否 | 用于返回字符串数据 | Hello World. |
| item | Object | 否 | 用于返回对像数据 | {"id":"1","name":"item1"} |
| list | Object | 否 | 用于返回列表数据 | |
| error_code | Int | 否 | 错误代码：500 系统错误, 300 验证错误 | |
| error_message | String | 否 | 错误信息（原因） |
- 返回字符串数据接口示例
调用接口地址：http://127.0.0.1:20081/index，返回
{
"status": "1",
"value": "Hello World."
}
- 返回对像数据接口示例
调用接口地址：http://127.0.0.1:20081/index/item，返回
{
"status": "1",
"item": {
"id": "1",
"name": "item1"
}
}
应用场景：通常用于返回实体对象数据。如：用户个人信息。
- 返回列表数据接口示例
调用接口地址：http://127.0.0.1:20081/index/list，返回
{
"status": "1",
"list": {
"page": "1",
"limit": "10",
"count": "100",
"items": [
{
"id": "1",
"name": "item1"
},
{
"id": "2",
"name": "item2"
},
{
"id": "3",
"name": "item3"
}
]
}
}
list参数说明
| 参数 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| page | Int | 是 | 当前页码 | 1 |
| limit | Int | 是 | 分页大小, 0 表示返回所有数据 | 10 |
| count | Int | 是 | 总记录条数 | 100 |
| items | Array | 是 | 对象数组 |
应用场景：通常用于返回分页列表数据。如: 行程列表。
- 返回错误数据接口示例
调用接口地址：http://127.0.0.1:20081/index/error，返回
{
"status": "0",
"error_code": "300",
"error_message": "错误来啦"
}
应用场景：通常用于系统错误或接口调用失败。如：登陆失败。
- 返回H5页面接口示例
调用接口地址：http://127.0.0.1:20081/index/h5，返回
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>This is main layout!</h1>
<h2>This is the "index" controller layout!</h2>
<h3>This is show view!</h3>
<p>I have received the parameter 测试</p>
</body>
</html>
应用场景：通常用于返回内容经常更改，布局灵活的协议内容或活动页面。
注意：
JSON接口响应数据，INT型参数也加有引用，如 {"status": "0"｝，APP开发中，按字符串接收，再根据实际需要做数据类型转换。
下一章，将讲解这些示例接口的具体实现。
