1. 描述
本章节以关闭社区接口为例来解释资源关闭接口在设计时的一系列考虑。
2. 资源名称
PUT:http://api.xdua.com/zone.disable/[id]
[!danger|label:为什么以zone.disable为url字段?] 首先必须用
资源.动作的方法来表示对资源的动作。我们这个时候可以认为disable是zone的一个属性。
3. 请求参数
| 名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 |
|---|---|---|---|---|---|---|
| id | path | string | 是 | rYub4wrT | 要关闭的社区ID | |
| state | body | int | 是 | 1 | 社区关闭时的状态。系统规定常数。取值：1 | |
| stato | body | string | 否 | 社区的状态说 | ||
| expire | body | int | 否 | 社区状态过期时间(UNIX时间戳) |
:blush:
[!danger|label:为什么还要把state属性放在客户端?] :blush:
- 首先，这个是一个修改资源的接口，还需要在表现形式上保持与PUT接口一样的形式。
- 其次，一个替代选择是，我们在网关把state设置成常量1，但是Api网关只能把state设置在query字段而不是body。这样并不好看。
结论: 我们还是放在客户端来放置state。
4. 返回参数
| 名称 | 位置 | 类型 | 示例 | 说明 |
|---|---|---|---|---|
| id | result | string | rYub4wrT | 关闭的社区ID |