1.请求的URL
例如:{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
参数 | 描述 | 是否必选 |
---|---|---|
URl-scheme | 用于传输请求的协议,当前所有API均采用HTTPS协议。 | 是 |
Endpoint | 当前资源池或者通用的域名 | 是 |
resource-path | 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。 | 是 |
query-string | 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”, 例如“?userID=1”,表示查询用户ID为1的数据。 |
否 |
2.请求方法
方法 | 说明 |
---|---|
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
POST | 请求服务器新增资源或执行特殊操作。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
HEAD | 请求服务器资源头部。 |
PATCH | 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
3.请求消息头
名称 | 描述 | 是否必选 | 示例 |
---|---|---|---|
Content-Type | 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 | 是 | application/json |
.... | .... | .... | .... |