3.RESTful风格

介绍

RESTful是目前流行的互联网软件服务架构设计风格。

• 每一个URI代表一种资源

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

• 通过操作资源的表现形式来实现服务端请求操作。

• 资源的表现形式是JSON或者HTML。

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

两个关键特性：

• 安全性：当我们使用GET操作获取资源时，不会引起资源本身的改变，也不会引起服务器状态的改变。

• 幂等性：幂等的方法保证了重复进行一个请求和一次请求的效果相同

状态码分为以下5个类别：

• 1xx：信息，通信传输协议级信息

• 2xx：成功，表示客户端的请求已成功

• 3xx：重定向，表示客户端必须执行一些其他操作才能完成其请求

• 4xx：客户端错误，此类错误状态码指向客户端

• 5xx：服务器错误，服务器负责这写错误状态码

Spring Boot实现RESTful API

@GetMapping：处理GET请求，获取资源。@PostMapping：处理POST请求，新增资源。@PutMapping：处理PUT请求，更新资源。@DeleteMapping：处理DELETE请求，删除资源。@PatchMapping：处理PATCH请求，用于部分更新资源。

Swagger

Swagger能够自动生成完善的RESTful API文档，同时并根据后台代码的修改同步更新，同时提供完整的测试页面来调试API。

导入依赖

<!-- Swagger -->
<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>

创建配置类

@Controller
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        registry.addResourceHandler("/**").addResourceLocations(
                "classpath:/static/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations(
                "classpath:/META-INF/resources/webjars/");
        WebMvcConfigurer.super.addResourceHandlers(registry);
    }

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // com包下所有API都交给Swagger2管理
                .apis(RequestHandlerSelectors.basePackage("com"))
                .paths(PathSelectors.any()).build();
    }

      API文档页面显示信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("演示项目")
                .description("学习")
                .build();
    }
}

最后访问：http://localhost:8080/swagger-ui.html即可

我的最后效果：