10-summary.rst
1.37 KB
概述
概述
本服务用于为平台的各项服务提供统一的编码。
术语
- 编码:对常用的公共内容进行编码。
关于接口返回内容的统一说明
- 采用标准HTTP返回状态码向接口调用者指出操作是否成功,例如2xx均表示成功,4xx和5xx表示失败。
- 对于HTTP返回状态码2xx的情况,本文档各个接口分别规定了其响应内容的格式(即Response Body规定的格式)。
- 对于HTTP返回状态码非2xx的情况,可以不返回任何响应内容,即不含有Response Body。但是也可以返回一个以下格式的Response Body向调用者给出更详细的错误指示:
{"ecode": 0, # 整数类型,是平台自定义的错误码"enote": "The camera is created ok." # 字符串,关于错误的说明}
-
关于GET请求的统一参数的说明:
GET请求一般来说至少需要支持以下四个参数:
- offset: 本次返回列表项的起始偏移量,用于分页,不出现为0
- limit: 本次返回列表项的最大数量,用于分页,不出现为30
- order: 排序方向,asc表示升序,desc表示降序,不出现为desc
- sortby: 排序关键字,由各个接口决定,参见各个接口说明。