RESTful介绍
- RESTful是目前流行的互联网软件服务架构设计风格。
- REST (Representational State Transfer,表述性状态转移) -词是由Roy Thomas Fielding在2000年的博士论文中提出的,它定义了互联网软件服务的架构原则,如果-个架构符合REST原则,则称之为RESTful架构。
- REST并不是一个标准,它更像一组客户端和服务端交互时的架构理念和设计原则,基于这种架构理念和设计原则的Web API更加简洁,更有层次。
RESTful的特点
- 每一个URI代表一种资源
- 客户端使用GET、POST、 PUT、DELETE四种表示操作方式的动词对服务端资
源进行操作: GET用于获取资源,POST用于新建资源(也可以用于更新资源) ,PUT用于更新资源,DELETE用于删除资源。 - 通过操作资源的表现形式来实现服务端请求操作。
- 资源的表现形式是JSON或者HTML。
- 客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个
请求都包含必需的信息。
RESTful API
- 符合RESTful规范的Web API需要具备如下两个关键特性:
- 安全性:安全的方法被期望不会产生任何副作用,当我们使用GET操作获取资
源时,不会引|起资源本身的改变,也不会引|起服务器状态的改变。 - 幂等性:幂等的方法保证了重复进行一个请求和一次请求的效果相同(并不是
指响应总是相同的,而是指服务器上资源的状态从第一次请求后就不再改变
了),在数学上幂等性是指N次变换和一次变换相同。
主要是四种mapping属性
- Spring Boot提供的spring-boot-starter-web组件完全支持开发RESTful API,提供了与REST操作方式(GET、POST、PUT、DELETE)对应的注解。
- @GetMapping:处理GET请求,获取资源。
- @PostMapping:处理POST请求,新增资源。
- @PutMapping:处理PUT请求,更新资源。
- @DeleteMapping:处理DELETE请求,删除资源。
- @PatchMapping:处理PATCH请求,用于部分更新资源。
swagger的使用
- swagger:主要用于接口测试以及前端接口文档
- pom.xml添加依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com"))
.paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("演示项目API")
.description("演示项目")
.version("1.0")
.build();
}
}
#对swagger进行兼容配置
spring.mvc.pathmatch.matching-strategy=ant_path_matcher
- 输入网址访问成功http://localhost:8080/swagger-ui.html
- 通过在mpping上面加入@ApiOperation(“获取用户”)进行说明