6RestFul API-Java Spring

6.1 RestFul API介绍

Rest表示性状态转移（Representation State Transfer），用URI表示资源，用HTTP方法(GET, POST, PUT, DELETE)表征对这些资源的操作，用于 Web 数据接口的设计，Rest的最基本特征是面向资源

• Resource 资源，资源是构成应用系统的所有的基本概念，即数据
• Representational 表述，REST的资源可以用XML，JSON，纯文本等多种方式表述
• State Transfer 状态转移，客户端通过HTTP的GET/POST/PUT/DELETE/PATCH对资源进行操作，实现资源的状态转移

6.2 URL构成

Restful API用URL表示特定的资源或资源集合，例如http://www.xxx.com/goods

• URI（统一资源标识符）用于标识一个资源，提供标识资源的方法
• URL（统一资源定位符）用于提供找到某个资源的路径，比如网址
• URL是URI的子集

6.3 RestFul API原理

RESTful API 是一种指REST设计风格的API，采用HTTP做传输协议，用一套协议来规范多种形式的前端和同一个后台的交互方式

用户在Android、IOS、PC等终端平台向服务端发送请求后，需要为每个平台的数据请求单独定义相应的返回格式，需要为每个平台单独写一个后台系统

而RESTful API 要求前端用一套协议来规范的语法格式发送请求，并与同一个后台系统交互，服务端只需要定义一个统一的响应接口（API）即可

传统API

• http://localhost:8080/user/queryUser （GET查询用户）
• http://localhost:8080/user/addUser（POST添加用户）
• http://localhost:8080/user/updateUser （PUT更新用户）
• http://localhost:8080/user/deleteUser （DELETE删除用户）

RestFul API

• http://localhost:8080/user/1 （@GetMapping("/user/{userId}") 查询）
• http://localhost:8080/user （@PostMapping("/user") 添加或修改）
• http://localhost:8080/user （@PutMapping("/user") 修改）
• http://localhost:8080/user/1 （@DeleteMapping("/user/{userId}") 删除）

6.4 RestFul API映射注解

6.5 RestFul API操作

RestFul API接口响应的资源（返回给前端的数据格式）的表现形式是， @RestController与@Controller标签相同，用于标注在类定义前面，使得类会被认定为Controller对象，用于告知Spring容器，该类所有方法的返回值需要以JSON或XML格式写到@ResponseBody内

• 可在控制类（@Controller类）上添加@ResponseBody 注解
• 可在每个接口的方法上添加@ResponseBody 注解
• 可把@ResponseBody注解提取到控制器上，这个控制器中所有的返回值会写到@ResponseBody内
• 可在控制类（@Controllerr类）上合并@Controller和@ResponseBody成一个@RestController注解

RestFul API通过两种方式实现定义接口的URL

1.指定请求方式

• @RequestMapping(value ="/user", method = RequestMethod.GET) 查询

2.特定请求方式

• @PostMapping("/user") 添加或修改

HTTP的五种请求方法

HTTP状态码

共用HTTP状态码

GET请求

Get请求的HTTP状态码

POST请求

Post请求的HTTP状态码

PUT请求

PUT请求的HTTP状态码

DELETE请求

Delete请求的HTTP状态码

这篇好文章是转载于：学新通技术网