.enableSwagger() // 开启 swagger 模式,有什么用
时间: 2024-01-12 14:03:42 浏览: 130
Swagger是一种API文档自动生成工具,它可以根据API接口的注释信息生成API文档,并提供了一系列的工具来测试和查询API接口。在MyBatis Plus的代码生成器中,可以使用`.enableSwagger()`方法来开启Swagger模式。
开启Swagger模式后,MyBatis Plus的代码生成器将会在生成的代码中添加Swagger相关的注释信息,这些注释信息可以被Swagger解析并生成API文档。使用Swagger可以让你很方便地查看和测试API接口,同时也可以提高API接口的文档化程度,方便其他人使用和维护。
例如,在Spring Boot项目中,你可以在pom.xml文件中添加Swagger的依赖:
```
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
```
然后,在MyBatis Plus的代码生成器中开启Swagger模式:
```
AutoGenerator mpg = new AutoGenerator();
...
// 开启Swagger模式
mpg.enableSwagger();
...
```
在生成的代码中,MyBatis Plus的代码生成器将会添加Swagger相关的注释信息,例如:
```
@ApiModel(value="User对象", description="用户对象")
public class User {
@ApiModelProperty(value = "用户ID", example = "1")
private Long id;
@ApiModelProperty(value = "用户名", example = "张三")
private String name;
@ApiModelProperty(value = "年龄", example = "18")
private Integer age;
// 省略其他属性和方法
}
```
这些注释信息可以被Swagger解析,并生成API文档。你可以通过访问`http://localhost:8080/swagger-ui.html`来查看自动生成的API文档。
阅读全文