若依官网的代码生成文档

我觉得若依官方的代码生成教程过于简单，网上的教程很多连个效果图都没有。。

本文要达到的效果如下：[学生管理] 下有个 [学生信息] 菜单，里面可以增删改查

1、修改代码生成配置

这步其实可做可不做。

• 单应用：编辑ruoyi-admin中resources目录下的application.yml
• 多模块：编辑ruoyi-generator中的resources目录下的generator.yml

我们这里做的是单应用，所以改ruoyi-admin里的application.yml

author: lzy # 开发者姓名，生成到类注释上
packageName: com.ruoyi.student # 默认生成包路径
autoRemovePre: true # 是否自动去除表前缀
tablePrefix: stu # 表前缀

2、新建数据库表结构（单表）

若依建表有个要求：表字段 和 表，都需要加注释，注释就是生成页面的显示内容

这个sql和官网的sql除了表名其他都一样，我们用这个建表
（如果是用图形化工具或者自己写SQL一定要记得加注释）

drop table if exists stu_student;

create table stu_student (
  student_id           int(11)         auto_increment    comment '编号',
  student_name         varchar(30)     default ''        comment '学生名称',
  student_age          int(3)          default null      comment '年龄',
  student_hobby        varchar(30)     default ''        comment '爱好（0代码 1音乐 2电影）',
  student_sex          char(1)         default '0'       comment '性别（0男 1女 2未知）',
  student_status       char(1)         default '0'       comment '状态（0正常 1停用）',
  student_birthday     datetime                          comment '生日',
  primary key (student_id)
) engine=innodb auto_increment=1 comment = '学生信息表';

3、项目中新建模块，并解决项目依赖的关系

①新建一个名为 ruoyi-student 的模块：


②我们要在 RuoYi 整个项目下的pom.xml中引入刚刚新建的模块：

<!-- 学生模块-->
<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-student</artifactId>
    <version>${ruoyi.version}</version>
</dependency>

③还需要在ruoyi-admin这个模块的pom.xml中引入刚刚新建戴尔模块：

<!--学生模块-->
<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-student</artifactId>
</dependency>

④由于自动生成的代码会用到ruoyi-common中的内容，我们需要将ruoyi-common引入到我们新建的模块中：（不做这个后面代码会报错，也会自动引入）

<dependencies>
    <dependency>
        <groupId>com.ruoyi</groupId>
        <artifactId>ruoyi-common</artifactId>
    </dependency>
</dependencies>

4、若依系统中新建一个目录 - 学生管理

但是现在只是建好了目录，里面还没有内容，所以打开是404。

5、导入一开始建的表并设置上级目录，生成代码

把刚刚新建的表导入：

导入后点击 [编辑] ，[生成信息] ：建议把生成模块名和生成业务名写的不一样，否则后面可能会遇到问题，后面运行时会讲到。

设置完毕后，生成代码。

这里说明一些上面填的东西会生成什么

• 生成包路径 com.ruoyi.student，就是生成的后端代码的包路径
  
• 生成模块名和生成业务名一起构成后端代码里自动生成的请求路径，即页面路径
  
  

6、执行生成的SQL

自动生成的压缩包里有个SQL，这是用来生成菜单的，去数据库里执行一下这个SQL。

执行完后【学生管理】下就有【学生信息】这个菜单了，但是旁边还没有页面，因为我们代码还没放进项目。

7、将生成的代码放入项目中

①将自动生成的代码文件main目录直接复制到我们的新建模块的src下，替换原本的main目录。

若此时报错则是该模块没有引入ruoyi-common，见第3步的④。

②将templates目录拷贝到ruoyi-admin目录下的resources中：

8、重启项目，访问页面

注意：如果在上面取名的时候，生成模块名和生成业务名取的是一样的，可能会遇到一个问题：将代码从Idea移到项目中时候，windows会将相同的两层文件夹自动合并。
比如：templates.student.student.会被合并为templates.student，此时在Idea里右键改名是没用的（它会把文件夹名字改为student.student，并不是两层文件夹），需要去磁盘里手动调整目录，再回来运行。

一定要重启！然后就可以访问了。

然后按自己的需要修改，定制。

1、若依系统会自带有swagger生成接口文档，登录若依系统后可以在

这里查看系统的接口demo。
如果想更改这个接口文档的样式可以参考地址：
https://blog.csdn.net/qq_22734863/article/details/113341869
2、我修改样式的方法

<dependency>
      <groupId>com.github.xiaoymin</groupId>
     <artifactId>swagger-bootstrap-ui</artifactId>
     <version>1.9.6</version>
</dependency>

然后在项目中全局搜索：将swagger-ui.html修改成doc.html。我的一共是修改了两个地方分别是：

3、swagger使用的方法可以参考：
添加链接描述
（1）

@Api ：请求类的说明

@Api：放在请求的类上，与 @Controller 并列，说明类的作用，如用户模块，订单类等。
tags=“说明该类的作用”
value=“该参数没什么意义，所以不需要配置”

举例：
@Api(tags = “账户相关模块”)
@RestController
@RequestMapping("/api/account")
public class AccountController {
//TODO
}
（2）

@ApiOperation：方法的说明

@ApiOperation：“用在请求的方法上，说明方法的作用”
value=“说明方法的作用”
notes=“方法的备注说明”

举例：
@ApiOperation(value = “修改密码”, notes = “方法的备注说明，如果有可以写在这里”)
@PostMapping("/changepass")
public AjaxResult changePassword(@AutosetParam SessionInfo sessionInfo,
@RequestBody @Valid PasswordModel passwordModel) {
//TODO
}

（3）

@ApiImplicitParams、@ApiImplicitParam：方法参数的说明

@ApiImplicitParams：用在请求的方法上，包含一组参数说明
@ApiImplicitParam：对单个参数的说明
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（请求体）–> @RequestBody User user
· form（普通表单提交）
dataType：参数类型，默认String，其它值dataType=“int”
defaultValue：参数的默认值

举例：
@ApiOperation(value=“用户登录”,notes=“随边说点啥”)
@ApiImplicitParams({
@ApiImplicitParam(name=“mobile”,value=“手机号”,required=true,paramType=“form”),
@ApiImplicitParam(name=“password”,value=“密码”,required=true,paramType=“form”),
@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)
})
@PostMapping("/login")
public AjaxResult login(@RequestParam String mobile, @RequestParam String password,
@RequestParam Integer age){
//TODO
return AjaxResult.OK();
}

单个参数举例
@ApiOperation(“根据部门Id删除”)
@ApiImplicitParam(name=“depId”,value=“部门id”,required=true,paramType=“query”)
@GetMapping("/delete")
public AjaxResult delete(String depId) {
//TODO
}

（4）

@ApiResponses、@ApiResponse：方法返回值的说明

@ApiResponses：方法返回对象的说明
@ApiResponse：每个参数的说明
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类

举例：
@ApiOperation(value = “修改密码”, notes = “方法的备注说明，如果有可以写在这里”)
@ApiResponses({
@ApiResponse(code = 400, message = “请求参数没填好”),
@ApiResponse(code = 404, message = “请求路径找不到”)
})
@PostMapping("/changepass")
public AjaxResult changePassword(@AutosetParam SessionInfo sessionInfo,
@RequestBody @Valid PasswordModel passwordModel) {
//TODO
}

（5）

@ApiModel：用于JavaBean上面，表示一个JavaBean

@ApiModel：用于JavaBean的类上面，表示此 JavaBean 整体的信息
（这种一般用在post创建的时候，使用 @RequestBody 这样的场景，请求参数无法使用 @ApiImplicitParam 注解进行描述的时候 ）

（6）

@ApiModelProperty：用在JavaBean的属性上面，说明属性的含义

@ApiModel和 @ApiModelProperty举例：
@ApiModel(“修改密码所需参数封装类”)
public class PasswordModel
{
@ApiModelProperty(“账户Id”)
private String accountId;
//TODO
}

然后以一个我自己写的Controller为例参考下：

然后在系统的界面可以看到这个接口文档：

在浏览器中输入：
localhost:8080/ruoyi-admin/doc.html
同样可以看到接口文档