集册 HTTP API 设计指南 使用统一的资源路径格式

使用统一的资源路径格式

欢马劈雪     最近更新时间:2020-08-04 05:37:59

469

资源名称

使用复数来命名资源,除非该资源在系统中是单件(比如,在绝大多数系统中,一个用户只能拥有一个账户)。这样在你引用特定资源时可以保持一致性。

对独有的资源使用不需要特定动作的 endpoint 格式。这样当需要特定的动作,只需要把它们放到标准的 actions 前缀后边,就可以清晰的描述它们:

/resources/:resource/actions/:action

如:

/runs/{run_id}/actions/stop