springboot+vue(4)
发表于:2022-08-27 |
字数统计: 994 | 阅读时长: 4分钟 | 阅读量:

RESTful

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

REST并不是一个标准,它更像一组客户端和服务端交互时的架构理念和设计原则,基于这种架构理念和设计原则的Web API更加简洁,更有层次。

每一个URI代表一种资源

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

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

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

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

符合RESTful规范的Web API需要具备如下两个关键特性:

安全性:安全的方法被期望不会产生任何副作用,当我们使用GET操作获取资源时,不会引起资源本身的改变,也不会引起服务器状态的改变。

幂等性:幂等的方法保证了重复进行一个请求和一次请求的效果相同(并不是指响应总是相同的,而是指服务器上资源的状态从第一次请求后就不再改变了),在数学上幂等性是指N次变换和一次变换相同。

HTTP Method

image-20220827203852479

状态码

HTTP状态码就是服务向用户返回的状态码和提示信息,客户端的每一次请求,服务都必须给出回应,回应包括HTTP状态码和数据两部分。

HTTP定义了40个标准状态码,可用于传达客户端请求的结果。状态码分为以下5个类别:

1xx:信息,通信传输协议级信息

2xx:成功,表示客户端的请求已成功接受

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

4xx:客户端错误,此类错误状态码指向客户端

5xx:服务器错误,服务器负责这写错误状态码

image-20220827204045162

Spring Boot实现RESTful API

Spring Boot提供的spring-boot-starter-web组件完全支持开发RESTful API,提供了与REST操作方式(GET、POST、PUT、DELETE)对应的注解。

@GetMapping:处理GET请求,获取资源。

@PostMapping:处理POST请求,新增资源。

@PutMapping:处理PUT请求,更新资源。

@DeleteMapping:处理DELETE请求,删除资源。

@PatchMapping:处理PATCH请求,用于部分更新资源。

package top.rczmm.springboot1.Controller;

import org.springframework.web.bind.annotation.*;
import top.rczmm.springboot1.poji.User;


@RestController
public class HelloWorld {
    @GetMapping("/user/{id}")
    public String getUserId(@PathVariable int id){
        return "user's id";
    }

    @PostMapping("/user")
    public String saveUser(User user){
        return "add user";
    }

    @PutMapping("/user")
    public String updateUser(User user){
        return "update user";
    }

    @DeleteMapping("/user/{id}")
    public String deleteUser(@PathVariable int id){
        return "delete user";
    }
}

Swagger

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务,是非常流行的API表达工具。

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

<!--        swagger-->
         <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
package top.rczmm.springboot1.configuration;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfiger {

    @Bean
    public Docket creatRestApiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("top"))
                .paths(PathSelectors.any()).build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("XXAPI").description("study swagger2").build();
    }
}

要注意的是,springboot 2.6 之后和swagger有冲突。

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

此时访问路径为:http://localhost:8080/swagger-ui/index.html

注意,文档中Swagger为3.0。

image-20220827214240354

上一篇:
springboot+vue(5)
下一篇:
springboot+vue(3)