|
本文介绍了Spring Boot 开发REST接口最佳实践，分享给大家，具体如下：
HTTP动词与SQL命令对应
GET
从服务器获取资源，可一个或者多个，对应SQL命令中的SELECT
GET /users
获取服务器上的所有的用户信息
GET /users/ID
获取指定ID的用户信息
POST
在服务器上创建一个新资源，对应SQL命令中的CREATE
POST /users
创建一个新的用户
PUT
在服务器上更新一个资源，客户端提供改变后的完整资源，对应SQL命令中的UPDATE
PUT /users/ID
更新指定ID的用户的全部信息
DELETE
从服务器上删除一个资源，对应SQL命令中的DELETE
DELETE /users/ID
删除指定ID的用户信息
PATCH
在服务器更新一个资源的部分属性，对应SQL命令中的UPDATE
PATCH /users/ID
更新指定ID的用户的某个属性
URL中的约定
URL中名词使用复数形式
URL中的名称是使用单数还是使用复数的问题，争议由来已久。URL中的名词一般对应数据库中的表，表中存储的是同类数据， 在实践中我是强制使用复数形式 ，看上去更舒服些。
/users
/users/1
/roles
/roles/1
至于一些不规则的、不可数的名词就见仁见智吧。
/heroes
/heroes/1
/people
/people/1
/foots
/foots/1
/feet
/feet/1
版本
讲版本号加入到URL中以应对不兼容的和破坏性的更改。发布新API时，客户端可以自如的迁移到新API，不会因调用完全不同的新API而陷入窘境。使用直观的“V”前缀来表示后面的数字是版本号，不需要次级版本号，不应该频繁的发布API版本。
/edu/v1/users
/edu/v1/roles
对可选的、复杂的参数使用查询字符串
为了让URL更小、更简洁，为资源设置一个基本URL，讲可选的、复杂的参数用查询字符串表示。
/edu/v1/users?enabled=1&roleid=1
提供分页信息
一次性返回数据库中的所有的资源不是一个好主意，因此需要提供分页机制。通常使用数据库中众所周知的参数offset和limit
/edu/v1/users?enabled=1&offset=1&limit=15
如果客户端没有传递这些参数，则应使用默认值，通常offset=0，limit=10。
非资源请求使用动词
有时API调用并不涉及资源，在这种情况下，服务器执行一个操作病将结果返回给客户端。
考虑特定资源和跨资源搜索
提供对特定止缘的搜索很容易，只需要使用相应的资源集合，并将搜索字符串附加到查询参数中即可。
/edu/v1/users?username=李庆海
如果需要对所有资源提供全局搜索，则需要使用其他方法。
响应结果
使用小驼峰命名法作为属性标识符
通常，RESTful Web服务将被JavaScript编写的客户端使用。客户端会将JSON响应转换为JavaScript对象，然后调用其属性。因此，最好遵循JavaScript代码通用规范。
person.year_of_birth // 不推荐，违反JavaScript代码通用规范
person.YearOfBirth // 不推荐，JavaScript构造方法命名
person.yearOfBirth // 推荐
提供分页信息
返回结果比较多时，应提供分页信息。
{
"page": 0,
"size": 10,
"total": 3465,
"obj": [
]
}
Spring MVC开发REST接口
常用注解
@RestController
@RestController是@ResponseBody和@Controller的组合注解。
@RequestMapping
此注解即可以作用在控制器的某个方法上，也可以作用在此控制器类上。当控制器在类级别上添加@RequestMapping注解时，这个注解会应用到控制器的所有处理器方法上。处理器方法上的@RequestMapping注解会对类级别上的@RequestMapping的声明进行补充。
@PostMapping
组合注解，昍)Iй(4(kvB#~4(4(4(R"B7(%4(R"K&(4(/^r|4(4(v^r|4(4("8,4((?j3Vc4(4( 4(4(=R"~4( 4()IЁ4(AR"B7R4IAM4(A%R"K&IAM%4(AхR"K&IA4(AR"K&IA4(A" 8ǖ,IAЁ4(A锈?j3VVVIAЁ锤4( AUхх%锤ххРхР R"cr)Iйх)(4(:>Z V#zsn4(е聍顽х4(brZ j3ro疒j惚r'&*rokkR24( | 
转播
