2、术语及约定
协议数据在传输时,以网络字节序(即高字节优先)方式编排数据。 ## 2.1术语 #### 资源(URI): 在Web应用中,所有的事物都应该拥有唯一的ID,代表ID的统一概念是:URI。URI构成了一个全局命名空间,使用URI标识你的关键资源意味着它们获得了一个唯一、全局的ID。任何能够被命名的信息都能够作为一个资源:一份文档或一张图片,一个其他资源的集合,一个非虚拟的对象(例如:人,车,设备)等等。换句话说,任何可能最为一个创作者的超文本引用的目标的概念都必须符合资源的定义。一个资源是到一组实体的概念上的映射,而不是在任何特定时刻与改映射相关联的实体本身。 #### 资源请求方法(Methods): 客户端可以使用HTTP方法(如 GET/POST/PUT/DELETE)操作资源。使用方式与HTTP协议定义一致。 GET: 列出资源集合或子资源的所有成员。 PUT: 使用一个集合更新(替换)另一个集合。 POST: 在集合中创建数字资源,其 ID 是自动分配的。 DELETE:删除整个资源集合。 #### 参数传递方式: HTTP操作资源时,传递参数可以来自于HTTP请求的不同位置, PathParamURL的路径 QueryParamURL的查询参数 HeaderParamHTTP请求的头信息 CookieParamHTTP请求的Cookie ## 2.2约定 - 数据类型对应表: |类型|说明| |:---- |:------- | |String |字符串 | |Number |数字 | |Date |日期 | |JSON |JSON对象 | |Array |JSON数组 | - 数据请求方式: - 更新/创建:PUT - 删除:DELETE - 查询:GET、POST ## 2.3注意事项 中横杠:"-"表示方法过期,后续将停用 时间:文档所有带时分秒的时间(参数、字段等)都是UTC时间 访问限制:针对单个账户,每分钟访问次数不能超过100次.超过将会被锁定. 解锁方法:5分钟内没有任何访问将自动解锁.