本文介绍了Spring Boot 开发REST接口最佳实践,分享给大家,具体如下:
从服务器获取资源,可一个或者多个,对应SQL命令中的SELECT 获取服务器上的所有的用户信息 获取指定ID的用户信息
在服务器上创建一个新资源,对应SQL命令中的CREATE
在服务器上更新一个资源,客户端提供改变后的完整资源,对应SQL命令中的UPDATE 更新指定ID的用户的全部信息
从服务器上删除一个资源,对应SQL命令中的DELETE 删除指定ID的用户信息
在服务器更新一个资源的部分属性,对应SQL命令中的UPDATE 更新指定ID的用户的某个属性
URL中名词使用复数形式
URL中的名称是使用单数还是使用复数的问题,争议由来已久。URL中的名词一般对应数据库中的表,表中存储的是同类数据, 在实践中我是强制使用复数形式 ,看上去更舒服些。
至于一些不规则的、不可数的名词就见仁见智吧。
讲版本号加入到URL中以应对不兼容的和破坏性的更改。发布新API时,客户端可以自如的迁移到新API,不会因调用完全不同的新API而陷入窘境。使用直观的“V”前缀来表示后面的数字是版本号,不需要次级版本号,不应该频繁的发布API版本。
对可选的、复杂的参数使用查询字符串
为了让URL更小、更简洁,为资源设置一个基本URL,讲可选的、复杂的参数用查询字符串表示。
一次性返回数据库中的所有的资源不是一个好主意,因此需要提供分页机制。通常使用数据库中众所周知的参数offset和limit
如果客户端没有传递这些参数,则应使用默认值,通常offset=0,limit=10。
有时API调用并不涉及资源,在这种情况下,服务器执行一个操作病将结果返回给客户端。
考虑特定资源和跨资源搜索
提供对特定止缘的搜索很容易,只需要使用相应的资源集合,并将搜索字符串附加到查询参数中即可。
如果需要对所有资源提供全局搜索,则需要使用其他方法。
使用小驼峰命名法作为属性标识符
通常,RESTful Web服务将被JavaScript编写的客户端使用。客户端会将JSON响应转换为JavaScript对象,然后调用其属性。因此,最好遵循JavaScript代码通用规范。
* 用户凭借登录账号和登录密码进行登录 * 根据用户编号查询用户信息 * 账户注销,不删除用户的数据 * 每页的行数,默认10
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。