# swagger-generate

**Repository Path**: Ltp6/swagger-generate

## Basic Information

- **Project Name**: swagger-generate
- **Description**: idea swagger 注解生成插件
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-12-22
- **Last Updated**: 2024-02-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 介绍

本项目是IntelliJ IDEA的插件，能帮助 java 开发者自动生成 swagger 注解
支持 2021.3 以上版本

## 安装

打开IntelliJ IDEA -> plugins 搜索 swagger-generate ，安装重启即可

## 使用方式

- 选择要生成的类、方法、字段使用快捷键 `ctrl + '`(win)或者 `cmd + '`(mac)
  ![Snipaste_2024-01-03_22-39-07.png](images%2FSnipaste_2024-01-03_22-39-07.png)

- 在类上使用快捷键 `alt+insert`(win) 或者 `cmd + n`(mac)，然后选择 SwaggerGenerate

## 示例
1.根据 Controller类名生成tag标签自动去掉 Controller 字符</p>

```java

@Api(tags = {"user"})
@RestController
@RequestMapping("/api")
public class UserController {
    // ......
}
```

2.@ApiImplicitParam allowableValues 属性的支持</p>

```java
/**
 * 测试
 * @param captchaVO 验证码=>1->启用，2->禁用
 * @param captchaVO 验证码：1=启用，2=禁用
 * @param captchaVO 验证码:1->启用，2->禁用
 * @param captchaVO 验证码=>1->启用,2->禁用
 * @return 验证码
 */
@ApiImplicitParams({
        @ApiImplicitParam(value = "验证码=>1->启用，2->禁用", allowableValues = "1,2")
})
@ApiOperation(value = "测试", notes = "测试", httpMethod = "POST")
@PostMapping("/captcha")
public String getCode(@RequestBody CaptchaVO captchaVO) {
    return "出错了";
}
```

3.@ApiModelProperty allowableValues 属性的支持</p>

```java
/**
 * 事件类型：0->否,1->是
 * 验证码:1=启用，2=禁用
 * 验证码：1->启用，2->禁用
 * 验证码=>1->启用,2->禁用
 */
@ApiModelProperty(value = "事件类型：0->否,1->是", required = true, allowableValues = "0,1")
private String event;

```