前端对于接口规范要求
1.同一APP中,图片路径统一(要么都是全路径,要么都是半路径)
2.接口返回的msg信息明确(给出具体的提示语,我们需要弹出提示语),不要传空字符串,或者其他代码形式信息
3.接口必须有code msg data 不允许出现NULL,接口返回数据data中,结构固定(不能同一个接口data返回的类型这次数组下次空的就返回字符串)
4.APP在开发过程中,接口端能提供同一的code码,并标注对应的意思,不允许出现以下情况(例如:token失效后要请求成功 code给一个固定的数值如401 不能请求500,请求成功的code统一返回 1,失败返回 0)
5.接口文档中应标注好入参注释,返回参数注释及返回数据结构
6.时间戳根据UI页面呈现的结构进行格式化,返回展示
7.Json数据中的键,不要出现关键字,数字,汉字等内容
8.同一个应用中分页数据的结构应统一
例如: 不同开发人员输入的字段名应统一: 如total_page代表总页数...具体名称有后端人员定义,但要统一!!!!
{
msg: '',
code: '',
data: {
total_page: '',
current_page: '',
size: '',
list: [],
...
}
}
列表类
一级有数据
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": [...<array>
• -
{
• "id": 6,... <number>
• "title": "新冠是如何产生和快速传播的!!",... <string>
• "create_time": "2020-06-11 15:46",... <string>
• "play_num": 22,... <number>
• "cover_image": "/uploads/20200611/e853d13060b61d65c2e599c029deb735.jpg",... <string>
• "is_free": 1,... <number>
• "video_url": "/uploads/20200611/9ec8eb9a131f15baeb9ac4b1dbd1c0f9.mp4"... <string>
•}
•],
•"time": "2020-07-27 17:03:48"... <string>
}
一级无数据
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": […<array>
•],
•"time": "2020-07-27 17:03:48"... <string>
}
二级有数据 (例如通讯录)
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": […<array>
•{
•“key”: "title": "L",... <string>
•"list": […<array>
•{
• "id": 6,... <number>
• "title": "李帅帅",... <string>
•}
•]
•}
•{
•“key”: "title": "W",... <string>
•"list": […<array>
•{
• "id": 6,... <number>
• "title": "王富贵",... <string>
•}
•]
•}
•],
•"time": "2020-07-27 17:03:48"... <string>
}
单个对象类. (有数据)
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": {…<object>
•"top_status": "2",置顶审核:0=未申请,1=申请中,2=已同意 <string>
•"type": "video",文章类型:video=视频,images=图片,article=引用文章,default=图文消息 <string>
•"create_time": "09:00",创建时间 <string>
•"user": {...<object>
• "nickname": "后端啊啊测试",昵称 <string>
• "avatar": "/uploads/20200308/043c24b339da7b239dfc78b8967d309c.png",头像 <string>
• "gender": 11 男 2女 <string>
• },
•},
•"time": "2020-07-27 17:03:48"... <string>
}
单个对象类. (无数据) code = 0
{
•"code": 0,… <number>
•"msg": "操作成功",... <string>
"data": {…<object>
•},
•"time": "2020-07-27 17:03:48"... <string>
}
例如个人信息 (有数据)
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": {...<object>
•"nickname": "测试433",昵称 <string>
•"avatar": "https://xinli.xizangtiansheng.com/uploads/20200515/6a607d64fde20ba39d9bbd07572ddcfa.jpg",头像 <string>
•"level": […<array>
•{
• "id": 6,... <number>
•"title": "王富贵",... <string>
•}
•]
•"com_duration": "1:38:00"通话时长没有为空 <string>
•},
•"time": "2020-06-06 15:10:25"... <string>
}
例如个人信息 (个别没有数据数据) 返回返回格式一样 如 level nickname
{
•"code": 1,... <number>
•"msg": "操作成功",... <string>
"data": {...<object>
•"nickname": "",昵称 <string>
•"avatar": "https://xinli.xizangtiansheng.com/uploads/20200515/6a607d64fde20ba39d9bbd07572ddcfa.jpg",头像 <string>
•"level": […<array>
•]
•"com_duration": "1:38:00"通话时长没有为空 <string>
•},
•"time": "2020-06-06 15:10:25"... <string>
}