**1. 类的文档: `@Tag`**
```java
@RestController
@Tag(name = "账号接口")
public class AccountController { ... }
```
![](https://img.kancloud.cn/c3/ad/c3ad9cf3138d013c204698d7af0711ee_2160x255.png)
<br/>
**2. 方法的文档:`@Operation`**
```java
@Operation(summary = "根据账号id查找账号")
@GetMapping("/account/getById/{id}")
public String getById(@PathVariable("id") Integer id) {
return "" + id;
}
```
![](https://img.kancloud.cn/f2/0e/f20e303ee17f07a1a66fbdde758450e9_1782x96.png)
<br/>
**3. 参数的文档:`@Parameter`**
```java
@Operation(summary = "根据账号id查找账号")
@GetMapping("/account/getById/{id}")
public String getById(@Parameter(description = "账号id", example = "1000") @PathVariable("id") Integer id) {
return "" + id;
}
```
![](https://img.kancloud.cn/2f/f0/2ff0dd21698b6c36f1198facee5ac199_1795x482.png)
<br/>
**4. 参数的文档:`@Parameters`**
```java
@Parameters(
{
@Parameter(name = "id", description = "账号id", example = "1000"),
@Parameter(name = "username", description = "账号名", example = "zhangsan")
}
)
@Operation(summary = "根据账号id和账号名查找账号")
@GetMapping("/account/getByIdAndUsername")
public String getByIdAndUsername(@RequestParam("id") Integer id, @RequestParam("username") String username) {
return id + "." + username;
}
```
![](https://img.kancloud.cn/50/ee/50eeab9eb12864e6ada88f974f2d74aa_1607x700.png)
<br/>
**5. 实体的文档:`@Schema`**
```java
@Schema(description = "账号实体")
public class Account {
@Schema(description = "账号id", example = "1000")
private Integer id;
@Schema(description = "账号名", example = "zhangsan")
private String username;
@Schema(description = "密码", example = "123456")
private String password;
}
```
![](https://img.kancloud.cn/ee/17/ee17e854d0532987d33e669776278096_1939x484.png)
>[info]提醒:实体只有被 controller 层引用才能生成文档。
```java
/**
* Account 被 controller 层用做参数,或返回值
*/
@PostMapping("/account/getAcoount")
public Account getAccount(@RequestBody Account account) {
return account;
}
```
- Spring
- Spring是什么
- Spring与EJB对比
- Spring的组成
- 首个Spring程序
- IoC控制反转
- 什么是IoC
- IoC编程
- 依赖注入方式
- 不同变量注入
- AOP面向切面编程
- AOP思想
- AOP实现原理
- AOP关键术语
- AOP编程
- 5种增强方式
- 切入点规则
- 自动装配
- Spring注解开发
- Bean注解
- AOP注解
- 完全注解
- 配置文件拆分
- SpringBean
- Bean常用属性
- Bean作用域
- Bean生命周期
- SpringBoot
- SpringBoot是什么
- 项目创建
- 配置文件
- 配置类型
- 读取配置
- 占位符
- 多环境配置
- 配置优先级
- 更改配置文件
- 自定义IoC容器
- 常用组件
- ApplicationContextAware
- CommandLineRunner
- Boot[Web]
- 引入模板引擎
- 静态资源访问
- 指定首页
- JSP支持
- 注册拦截器
- 注册Servlet组件
- 注册Servlet
- 注册过滤器
- 注册监听器
- 拦截器与过滤器区别
- 文件上传
- 文件下载
- 变更服务器
- Controller层封装
- HttpServletRequest
- 获取请求行
- 获取请求头
- 获取请求体
- Boot[自动配置]
- 自动配置是什么
- 自动配置报告
- 关闭自动配置
- 条件注解
- Boot[场景启动器]
- 场景启动器是什么
- 自定义场景启动器
- Boot[日志]
- 日志框架
- 日志级别
- 日志配置
- 配置文件
- 切换日志
- Boot[邮件任务]
- Boot[定时任务]
- cron表达式
- 起步
- 任务并行
- 注解Scheduled参数
- Boot[异步任务]
- 起步
- 注意事项与原理
- 自定义线程池
- Boot[缓存]
- JSR107缓存技术
- Spring缓存抽象
- 缓存注解
- SpEL表达式
- 起步
- 自定义key生成器
- 工作原理
- Boot[Redis]
- 起步
- 序列化机制
- Boot[Jdbc]
- 起步
- 两个模板类
- JdbcTemplate
- 增删改
- 查询
- NamedParameterJdbcTemplate
- 增删改
- 查询
- 自定义JdbcTemplate
- Boot[JPA]
- SpringDataJPA是什么
- 与JPA、Hibernate的关系
- 起步
- SpringDataJPA原理
- 查询方式
- 方法命名规则查询
- 限制查询结果查询
- 注解Query查询
- 命名参数查询
- SpEL表达式查询
- 原生查询
- 更新与删除
- 查询指定字段
- Specification动态查询
- 分页查询与排序
- 多表查询
- 一对一查询
- 一对多查询
- 多对多查询
- Specification查询
- Query注解查询
- 主键策略
- 单独主键
- 联合主键
- 级联操作
- 加载规则
- 审计功能
- 常用注解
- 避坑指南
- Boot[JSR303]
- JSR303是什么
- 常用约束
- 起步
- 简单校验
- 嵌套校验
- 分组校验
- 自定义约束注解
- 自定义校验工具
- Spring事务
- 事务的作用
- 起步
- 事务参数
- SpringDoc文档
- SpringDoc是什么
- 起步
- 自定义配置
- 常用Doc注解
- JSR303文档
- knife4j文档
- 常用配置
- Boot[RabbitMQ]
- 起步
- Fanout交换机类型
- Direct交换机类型
- Topic交换机类型
- 延迟队列插件
- RabbitListener监听方法
- JWT认证
- 认证流程
- 起步
- 密码加密
- JWT认证实现