更细节的接口设计指南
这里还有一些其他参考资料:
- 推荐参考文档 HTTP API Design Guide 来设计 REST 风格的 API ,只有以下两点我个人并不建议参考:
- Use consistent path formats
还是不建议将动作写在 URL 中,像文档中的情况,可以将这个行为抽象成一个事务资源POST /runs/:run_id/stop-logs
或者POST /runs/:run_id/stoppers
来解决 - Paginate with Ranges
确实是一个巧妙的设计,但似乎并不符合Content-Range
的设计意图,而且有可能和需要使用到Content-Range
的正常场景冲突(虽然几乎不可能),所以不推荐
- Use consistent path formats
- Best Practices for Designing a Pragmatic RESTful API
- Thoughts on RESTful API Design
- The RESTful CookBook