REST APIs
是web服务中最常用的服务类型,让包括浏览器在内的大量客户端通过REST API
与服务器进行数据沟通。
所以,正确地设计REST APIs
很重要,这样在之后不会有问题。我们需要把账号安全、性能和API消费者的简单易用考虑进来。
在本文中,我们将研究如何设计REST APIs
,使其易于为任何使用它们的人理解、经得起未来考验,并且安全、快速.
作者在文中提出了几种准则用来更好地设计REST API
:
- 使用
JSON
接收和响应数据(Accept and respond with JSON) - 在端点路径中使用名词而不是动词(Use nouns instead of verbs in endpoint paths)
- 名词复数的名称集合(Name collections with plural nouns)
- 层次对象的嵌套资源(Nesting resources for hierarchical objects)
- 优雅地处理异常并返回标准的异常代码(Handle errors gracefully and return standard error codes)
- 允许过滤、排序和分页(Allow filtering, sorting, and pagination)
- 保持好的安全实践(Maintain Good Security Practices)
- 缓存数据以提升性能(Cache data to improve performance)
- 为
APIs
定义版本(Versioning our APIs)
说到底,web的标准,性能,端点路径等都是很重要的考虑因素,建议阅读原文。