若依分离版——使用Knife4j 自动生成接口文档

news2024/11/26 1:54:04

背景：

前后端分离程序，如果需要前端开发人员和后端开发人员配合开发，则需要将接口文档并显性给前端人员

解决办法：

使用knife4j替代若依自带的swagger，因为knife4j是在swagger基础上包装的，Knife4j不仅具备友好的界面，而且使用简单，还提供了增强功能如接口测试和Mock数据生成，可大大提高开发人员的工作效率。

效果如下：

具体步骤：

1、ruoyi-admin\pom.xml模块添加整合依赖

<!-- knife4j -->
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>3.0.3</version>
</dependency>

2、修改ry-ui\views\tool\swagger\index.vue跳转地址

url: process.env.VUE_APP_BASE_API + "/doc.html",

3.登录系统，访问菜单系统工具/系统接口，出现如下图表示成功。

4. 给SysUser类中的的字段添加 @ApiModelProperty(value = "用户序号", required = false)


    /** 用户ID */
    @ApiModelProperty(value = "用户序号", required = false)
    @Excel(name = "用户序号", cellType = ColumnType.NUMERIC, prompt = "用户编号")
    private Long userId;

    /** 部门ID */
    @ApiModelProperty(value = "部门编号", required = false)
    @Excel(name = "部门编号", type = Type.IMPORT)
    private Long deptId;

5. 给SysUserController添加 @ApiOperation("获取用户列表")

   /**
     * 获取用户列表
     */
    @PreAuthorize("@ss.hasPermi('system:user:list')")
    @ApiOperation("获取用户列表")
    @GetMapping("/list")
    public TableDataInfo list(SysUser user)
    {
        System.out.println(user.getNickName());
        startPage();
        List<SysUser> list = userService.selectUserList(user);
        return getDataTable(list);
    }

5. 重启启动，进入系统接口页面，在个性化设置里配置Host为本地地址，否则接口地址不正确