1 2 | // http://xxx/api/xxx/xxx // http://xxx/api/xxx/xxx?key1=value1&key2=value2&key3=value3 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | // http://xxx/api/xxx/xxx // 通用请求体 { key1: 200, key2: '响应消息', key3: { xxx: '', yyy: {}, zzz: [] }, key4: [ { xxx: 1, yyy: '', zzz: {} }, { xxx: 2, yyy: '', zzz: {} } ] } // 通用列表请求体 { // 列表业务用参数 key1: 200, key2: '响应消息', // 列表格式用参数 page: 1, // 请求页码(require) size: 20, // 请求每页展示数(require) sort: [ { // 列表排序方式 property: 'id', // 排序属性的key direction: 'ASC' // 排序方式 ASC[升序] | DESC[降序] } ] } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | // 通用对象返回 { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: { // 响应数据体(require) xxx: '', yyy: {}, zzz: [] } } // 通用数组返回 { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: [ // 响应数据体(require) { xxx: '', yyy: {}, zzz: [] } ] } // 通用列表返回(带分页查询) { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: { content: [ // 列表数据体(require) { xxx: '', yyy: {}, zzz: [] } ], sort: [ { // 列表排序方式 property: 'id', // 排序属性的key direction: 'ASC' // 排序方式 ASC[升序] | DESC[降序] } ], page: 1, // 当前页码(require) size: 20, // 每页展示数(require) total: 200, // 列表总数(require) totalPage: 10, // 列表总页数(require) isLast: 0 // loadmore用,是否最后一页(require) } } // 无数据返回格式需要按照数据体类型返回对应空数据体 { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: {} // 无数据(require) } { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: [] // 无数据(require) } { code: 200, // 响应状态码(require) msg: '响应消息', // 响应消息体(require) data: { content: [], // 无数据(require) sort: [{}], page: 1, // 当前页码(require) size: 0, // 每页展示数(require) total: 0, // 列表总数(require) totalPage: 0 // 列表总页数(require) isLast: 1 // loadmore用,是否最后一页(require) } } // 请求失败(网络不通,环境不对导致) { code: 500, // 错误状态码(require) msg: '响应消息', // 错误消息体(require) data: {} // (require) } // 请求失败(业务错误) { code: XXXXX, // 建议4-5位数错误码,用来和系统级别,通用错误码区分开来(require) msg: '响应消息', // 错误消息体(require) data: {} // (require) } |
支付宝扫一扫打赏
微信扫一扫打赏
共 0 条评论关于"【YQN】前后端对接接口API规范-企业开发项目流程"
最新评论