目录

概述

Swagger集成

​编辑具体实现

添加类上的注解

为每个方法添加注解

导包

效果展示

---

概述

Swagger是一个强大的API文档生成工具，它可以帮助我们自动生成在线接口文档，极大地提高了API文档的维护效率和易用性。

Swagger集成

我们的目标是：改造Controller模板，通过集成Swagger，我们将能够为当前的类和当前类的方法添加Swagger的相关注解，并生成相应的API文档。

具体实现

若依已经默认添加了Swagger的相关坐标，所以我们不需要手动添加Swagger依赖。

添加类上的注解

/**
 * 使用 Swagger 标记该控制器类的标签为 "${functionName}Controller"
 */
@Api(tags = "${functionName}Controller")

@Api注解，主要用于标记一个控制器类，其中tags属性指定了该控制器的标签名称。

为每个方法添加注解

添加方式如下图所示

@ApiOperation用于描述该方法的功能。

导包

对添加的两个注解进行导包操作

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

效果展示

按ctrl+f9，热部署一下后端

随便浏览一个生成的Controller:

可以看到，我们的修改已经生效了。

之后我们将代码放到项目中后，就可以在系统接口中查看API在线文档了：