Swagger使用

Swager

1 创建 common 公共模块,整个Swagger.
2 编写配置类.
3 其他模块引入 Swagger
在启动类中配置 Swagger
主要是 引入 Swagger模块的模块,扫描到 Swagger的配置类

@ComponentScan(basePackages = "cnn.nctwo")
@SpringBootApplication
public class EduApplication{
	public static void main(String[] args){
		SpringApplication.run(EduApplication.class,args);
	}
}

4 启动项目
访问: localhost:8001/swagger-ui.html
5 还可以对API设置额外的信息
读一些API的接收参数,API的说明,以及 类上添加相应的注解.编写对应的信息

返回统一数据格式

1 在 common 中定义common_utils 模块.
2 定义接口,定义接口中的字段:
状态码,数据
3 修改 Service-edu
修改 API的返回值

条件查询分页

使用之前的page类. 编写 QueryWrapper. 配置条件.
使用 通用mapper 进行查询.
通过 page 对象获得查询的数据

统一异常处理

在 common 中穿件 service_base 模块
编写 异常处理类
1 使用@ControllerAdvice 此类为异常处理类
2 编写方法
添加注解,声明此方法捕捉的异常

	@ExceptionHandler(Exception.class)
	@ResponseBody
	public R error(Exception e){
		e.printStackTrace();
		return R.error();
	}

返回统一时间格式

在 配置文件中配置

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

最后,如果需要处理 自定义异常的话.则 实现异常类,之后,在方法上进行捕捉即可.