API (应用程序编程接口) 两种用法
1.类似jar的使用:A软件将功能打包成组件(功能块:比如java中的jar),让B软件导入直接使用
2.http请求方式:A项目(系统)提供一个映射方法路径,B项目(系统)发起http请求得到对应功能 (应用请求方式)
应用接口:很多情况下,需要把系统的部分功能(组件)作为服务暴露给外部的其他应用使用,所以就需要把系统中的服务作为API接口暴露出去,一般分为公共接口和私用接口(公司内部)
前后端分离,字面意思就是 前端+后端分离,传统的开发模式前后端耦合过高,不利于维护,一旦前后端任意一方换,不利于开发.
优点:
是一种规范,规范后端编写的逻辑. REST是一种设计API的模式(风格),常用JSON数据格式(能被JS直接读取) , REST只是一种设计风格 , 而不是标准
传统的请求映射方法(接口)设计考虑要点:
1.请求路径 : /employee/list
2.请求方法:GET/POST
3.请求参数: employee对象
4.请求响应值: JsonResult对象
RESTful风格接口约束的要点:
1.请求路径: 要求是操作资源(实体对象:domain)名称复数 /employees
2.请求方式: 使用请求方式替换资源CRUD操作 :POST–新增 ,GET–查询 ,DELETE–删除 ,PUT–更新
3.请求参数:跟之前一样,需求决定
4.请求响应值:跟之前一样,需求决定,但是建议返回值都是json格式
网络上的所有事物都被抽象为资源
restful认为,每个资源都有自己唯一的资源定位符(URI), 每个URI都代表了一种资源,以一张图片为例:图片有自己的路径, 所以图片也是一种资源. 所以URI中不用动词,只用名词. 一般数据库的表都是记录同种的集合,所以为名词为复数 这就是为什么请求路径中的操作资源要加 s , 可以不遵循这个规范(看自己喜欢或者公司规范)
资源状态转换
当我们访问一个网站,必然代表客户端和服务端间的互动,这种互动,会涉及资源间的状态变化,HTTP协议，是一个无状态协议,所以资源的状态保存在服务器中,如果需要改变状态,需要使用http方法去让服务器资源发生改变.简单的说就是,对应请求发生改变
新增 :从无到有 更新:从某个状态变成另一个状态 删除 :从有到无
使用统一接口
REST要求，必须通过统一的接口来对资源执行各种操作
员工列表查询与员工单个查询,使用相同映射路径" /employees 和相同请求方法:RequestMethod.GET,
导致请求路径(路径+请求方法)一样,报错
restful提供解决方案:使用参数路径方法
参数路径:将参数作为请求路径的一部分 /employee/{id}
还要加上注解@PathVariable,将id拿到
浏览器/postman发起请求时使用:
http://localhost:8080/employee/1 其中1是id参数值,同时也是请求路径的一部分
另外,请求映射方法必须使用@PathVariable 进行参数读取
注意: 如果路径参数标记与请求参数名不一致时 ,怎么办?
可以使用@PathVariable("eid") value属性指定
@Controller
public class EmployeeController {
@RequestMapping(value = "employees",method = RequestMethod.GET)
@ResponseBody
public List<Employee> list(){
List<Employee> employees = Arrays.asList(new Employee(1L, "小罗", 22), new Employee(2L, "小轩", 18));
return employees;
}
@RequestMapping(value = "employees/{id}",method = RequestMethod.GET)
@ResponseBody
public Employee get(@PathVariable Long id){
List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));
return employees.get((int) (id-1));
}
@RequestMapping(value = "employees",method = RequestMethod.POST)
@ResponseBody
public Employee save(Employee employee){
employee.setId(1L);
return employee ;
}
@RequestMapping(value = "employees",method = RequestMethod.DELETE)
@ResponseBody
public JsonResult delete(Long id){
return new JsonResult(true,"删除成功");
}
@RequestMapping(value = "employees",method = RequestMethod.PUT)
@ResponseBody
public JsonResult update(Long id){
return new JsonResult(true,"更新成功");
}
}
参数路径方法与传统方式对比
参数路径方式: 优点:可以隐藏参数,避免暴露参数,相对安全 缺点:如果参数较多,url过长 不建议使用 参数较少选用参数路径方法
同一资源具有多种表现形式
HTTP请求的头信息中用Accept和Content-Type字段表现形式
Accept与Content-Type的区别
1.Accept属于请求头， Content-Type属于实体头。
2.Accept代表发送端（客户端）希望接受的数据类型。Content-Type代表发送端（客户端|服务器）发送的实体数据的数据类型。
Accept：application/json :代表客户端希望接受得数据类型是json类型,后台返回json数据 Content-Type：application/json:代表发送端发送数据格式是json,后台要以这种格式类接收前端的数据
删除,更新操作
$.ajax({
url: 路径 ,
type: 类型 ,
data: 参数{id:111},
success:(回调函数)function(data){
}
})
<script>
$(function () {
//查全部
$("#btn1").click(function () {
$.get("/employees" ,function (data) {
console.log(data);
})
});
//查单个
$("#btn2").click(function () {
$.get("/employees/1" ,function (data) {
console.log(data);
})
});
//新增
$("#btn4").click(function () {
$.post("/employees" ,{name:"xiao",age:18},function (data) {
console.log(data);
})
});
//删除
$("#btn3").click(function () {
$.ajax({
url:"/employees",
type: "DELETE",
data:{id:1},
success:function (data) {
console.log(data);
}
})
});
//更新
$("#btn5").click(function () {
$.ajax({
url:"/employees",
type: "PUT",
data:{id:1},
success:function (data) {
console.log(data);
}
})
})
})
</script>
springMVC默认不支持put请求,需要额外处理put或patch请求方式的过滤器,Springboot支持
<filter> <filter-name>httpPutFormContentFilter</filter-name> <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class> </filter> <filter-mapping> <filter-name>httpPutFormContentFilter</filter-name> <servlet-name>springMVC</servlet-name> </filter-mapping>
@GetMapper、@PostMapping、@DeleteMapping、@PutMapping
等价于 method =RequestMethod.GET|POST|DELETE|PUT
@RestController
等价于 @Controller +@ResponseBody
@PathVariable
通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法参数中
URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的参数中。
@RequestMapping标签属性
params :要求请求中必须携带指定名称的参数
params="name" :必须携带name参数
params="name=xuan" :必须携带name参数,并且name=xuan
headers :请求头，限定要处理请求的请求头信息，只有匹配才会被方法处理
consume :等价于Content-Type
value/path：映射路径
method：限定请求的方式
优化RESTful规范的 例子代码
@RestController
@RequestMapping("employees")
public class EmployeeController {
@GetMapping
public List<Employee> list(){
List<Employee> employees = Arrays.asList(new Employee(1L, "小罗", 22), new Employee(2L, "小轩", 18));
return employees;
}
@GetMapping(value = "/{id}")
public Employee get(@PathVariable Long id){
List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));
return employees.get((int) (id-1));
}
@PostMapping
public Employee save(Employee employee){
employee.setId(1L);
return employee ;
}
@DeleteMapping
public JsonResult delete(Long id){
return new JsonResult(true,"删除成功");
}
@PutMapping
public JsonResult update(Long id){
return new JsonResult(true,"更新成功");
}
}
API接口测试工具
Postman, Insomnia
RESTful开发框架
常见的有 SpringMVC , jersey , play
