springboot和vue:五、RESTful服务+HTTP状态码+swagger配置

RESTful

RESTful的特点

  • 每一个URI代表一种资源
  • 客户端使用GET、POST、PUT、DELETE四种表示操作方式的动词对服务端资源进行操作:POST用于新建资源(也可以用于更新资源),PUT用于更新资源
  • 资源的表现形式是JSON或者HTML。
  • 客户端与服务端之间的交互在请求之间是无状态的,从客户端到服务端的每个请求都包含必需的信息。

RESTful API的特点

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

  • 安全性:安全的方法被期望不会产生任何副作用,如,当我们使用GET操作获取资源时,不会引起资源本身的改变,也不会引起服务器状态的改变。
  • 幂等性:幂等的方法保证了重复进行一个请求和一次请求的效果相同(并不是指响应总是相同的,而是指服务器上资源的状态从第一次请求后就不再改变了)。

HTTP状态码

  • 1xx:信息,通信传输协议级信息
  • 2xx:成功,表示客户端的请求已成功接受
  • 3xx:重定向,表示客户端必须执行一些其他操作才能完成其请求
  • 4xx:客户端错误(一般就是我们后端出错了)
  • 5xx:服务器错误

200:GET请求成功。

201:POST/PUT请求成功。

204:DELETE请求成功。

400:POST/PUT请求错误

401:用户没有权限

404:用户请求了不存在的资源。

用户管理模块API

swagger

pom.xml文件里新增:

注意:

在config包下新建Swagger2Config类

复制代码
package com.itheima.reggie.config;

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @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("demo")
                .description("swagger-test")
                .build();
}
}

访问 http://127.0.0.1:8080/swagger-ui.html

相关注解

@Api(value="xxx") ,用在类头上

@ApiOperation(value="xxx"),用在方法头上

相关推荐
paopaokaka_luck16 分钟前
基于Spring Boot+Vue的巴彦淖尔旅游网站(AI问答、腾讯地图API、WebSocket及时通讯、支付宝沙盒支付)
数据库·vue.js·spring boot·websocket·mysql·毕业设计·旅游
hello 早上好20 分钟前
多线程(1)
java
paopaokaka_luck1 小时前
基于Spring Boot+Vue的DIY手工社预约管理系统(Echarts图形化、腾讯地图API)
java·spring boot·后端
kk_stoper1 小时前
使用Ruby接入实时行情API教程
java·开发语言·javascript·数据结构·后端·python·ruby
我会冲击波1 小时前
告别flag与status:如何为你的布尔值(boolean)变量优雅命名?
java·后端
工藤学编程1 小时前
分库分表之实战-sharding-JDBC水平分库+分表后:查询与删除操作实战
数据库·spring boot·后端·sql·mysql
爱吃土豆的马铃薯ㅤㅤㅤㅤㅤㅤㅤㅤㅤ1 小时前
如何将一个本地的jar包安装到 Maven 仓库中
java·maven·jar
N维世界1 小时前
Mybatis-XML映射文件
xml·java·mybatis
码出极致1 小时前
Redisson 分布式锁自动续期机制解析
后端
小塵2 小时前
【DeepSeek 聊天】五分钟部署本地 DeepSeek
人工智能·后端·deepseek