mybatis-plus 代码生成器集成 swagger3
时间: 2023-09-15 13:22:53 浏览: 229
Mybatis-Plus 的代码生成器可以大大提高开发效率,能够快速生成基本的 Mapper、Entity、Service、Controller 等代码。如果想要在生成的 Controller 中集成 Swagger3,可以按照以下步骤进行操作:
1. 在 pom.xml 文件中添加 Swagger3 依赖:
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
2. 在代码生成器的配置文件 `generatorConfig.xml` 中添加 Swagger3 相关注释插件:
```xml
<plugin type="io.github.swagger2markup.Swagger2MarkupConverterMojo">
<configuration>
<swaggerInput>http://localhost:8080/v3/api-docs</swaggerInput>
<outputFile>src/main/resources/docs/swagger</outputFile>
<config>
<swagger2MarkupConfig>
<swaggerMarkupLanguage>MARKDOWN</swaggerMarkupLanguage>
</swagger2MarkupConfig>
</config>
</configuration>
</plugin>
```
其中,`swaggerInput` 是指定 Swagger3 的 API 文档地址,`outputFile` 是指定生成的文档存储路径。
3. 在生成的 Controller 类中添加 Swagger3 注解,如:
```java
@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController {
@Autowired
private UserService userService;
@ApiOperation(value = "根据用户ID获取用户信息")
@GetMapping("/{id}")
public User getUserById(@PathVariable Long id) {
return userService.getById(id);
}
}
```
其中,`@Api` 注解用于描述 Controller 的作用,`@ApiOperation` 注解用于描述 Controller 中的方法作用。其他注解可以根据实际需要进行添加。
4. 运行代码生成器,生成的 Controller 类中就会包含 Swagger3 相关注解。
以上是 Mybatis-Plus 代码生成器集成 Swagger3 的简单示例,具体实现方式可以根据项目需要进行调整。
阅读全文