rest 在java中的最佳实践

什么是rest

一种软件架构风格,在代码中形成一种规范,一种约定,一种约束,可以降低开发的复杂性,提高系统的安全性、可伸缩性

最贱实践

    最佳实践(test practice)是一个管理学概念,认为存在某种技术、方法、过程、活动、或者机制可以使生产或者管理实践的结果达到最优,并减少出错的可能性。

    所谓最佳实践,是那些已经在别处产生显著效果,并能使用于此处的优秀实践。

    

应用

rest 风格的要求

返回的状态码,必须严格遵循规则,

@PostMapping
@ResponseBody
public ResponseEntity<Item> saveItem(Item item){
    if(item.getPrive()==null){
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(null);
    }
    item = itemService.saveItem(item);
    return ResponseEntity.status(HttpStatus.CREATED).body(item);
}

1,路径的要求

get:获取资源

扫描二维码关注公众号,回复: 4893148 查看本文章

post:创建资源

put:修改资源

delete:删除资源

rest风格中路径中不能有动词

用一样的url,通过请求类型判断增删改查,

接口设计

url的组成

  网络协议(http、https)

  服务器地址

  接口名称

  参数列表

url定义限定

不要使用大写字母

使用中线“-”代替“_”

参数应该被encode过

响应设计

响应规则

Content body 仅仅用来传输数据

数据要做到拿来就可用的原则,不需要拆箱的过程

用来描述数据或者请求的元数据放Header中,例如X-Result-Fields

猜你喜欢

转载自blog.csdn.net/qq_34874784/article/details/85838967