REST API

文档约定

语法

接口语法描述，使用 ${var} 的类 shell 语法表示变量。

请求参数

HTTP 请求 URL 参数说明，参数列表以 ? 开始，多个参数之间以 & 隔开。

请求头

HTTP Reqeust Header 说明，每个接口特有的请求头在接口定义中给出，请参阅 通用请求头。

请求元素

HTTP PUT/POST 请求的 entity-body 中的 xml element 说明，通常比较多的内容用请求参数不友好，需要用 entity 来请求。

响应头

HTTP Response Header 说明。

响应元素

响应的 entity-body 中的 xml element 说明。

RFC

文档中备注的 RFC 语义参考 http://www.w3.org/Protocols 对 HTTP 相关 RFC 的解释。