2021-05-19

什么是Restful ？什么是Restful  API？

REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。

RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。

RestFul特点包括：

1、每一个uri代表1种资源

2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源；

3、通过操作资源的表现形式来操作资源

4、资源的表现形式是XML或者HTML；

5、客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。

 

什么是Restful  API？

状态码：建议使用 HTTP 的状态码；  

    200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。    

    201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。  

    202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）    

    204 NO CONTENT - [DELETE]：用户删除数据成功。    

    400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。  

    401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。

    403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。    

    404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。  

    406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。

    410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。    

    422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。  

    500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。。

 

错误处理：返回指定错误信息内容：

{  

     "error":"err message"

}

1、发送RestFul请求：

获取全部资源 获取所有用户：GET http://localhost:8086/api/user/users/

获取单个资源 获取用户：GET http://localhost:8086/api/user/users/3

删除一个资源：DELETE http://localhost:8086/api/user/users 请求参数：{    "userId": 1 }

 

 发送和接受RestFul请求 Spring的复杂性不是来自于它处理的对象，而是来自于自身，不断演进发展的Spring会带来时间维度上复杂性，比如SpringMVC以前版本的@RequestMapping，到了新版本被下面新注释替代，实现针对RestFul的风格的API：

@GetMapping

@PostMapping

@PutMapping

@DeleteMapping

@PatchMapping

 

2. 发送和接受RestFul请求 映射注解说明：

1、@GetMapping @RequestMapping(method = RequestMethod.GET)的简写      作用：对应查询，表明是一个查询URL映射

2、@PostMapping @RequestMapping(method = RequestMethod.POST)的简写      作用：对应增加，表明是一个增加URL映射

3、@PutMapping @RequestMapping(method = RequestMethod.PUT)的简写          作用：对应更新，表明是一个更新URL映射

4、@DeleteMapping @RequestMapping(method = RequestMethod.DELETE)的简写      作用：对应删除，表明是一个删除URL映射

5、@PatchMapping Patch方式是对put方式的一种补充; put方式是可以更新.但是更新的是整体.patch是对局部更新;