IDEA插件-SwaggerModelDoc

平时开发Restful接口时,喜欢用Swagger做自动接口展示调用的小伙伴有福了~

如果想通过Swagger展示接口注释,需要在实体上添加Swagger注解,该插件可以根据javadoc的注释自动添加Swagger注解,节省编码时间。

第一步:下载该插件的jar:下载地址:SwaggerModelDoc.jar下载

第二部本地安装:File-->Settings-->Plugins-->Install plugin from disk-->选择下载的SwaggerModelDoc.jar,点击确定,然后重启IDEA;重启之后检查是否安装成功;

第三部:创建实体类进行测试

实体类:

/**
 * test-main-manager-v3.0
 * Created by xian.juanjuan on 2016-11-18 09:28.
 */
public class TestSwaggerModelDoc {

    /**
     * 用户ID
     */
    private String userId;

    /**
     * 用户名称
     */
    private String userName;

}

alt+insert 快捷键,选择插入 SwaggerModelDoc文档,会自动在属性上添加注解,生成get,set方法,并且在方法上添加注释,方便调用;

import com.wordnik.swagger.annotations.ApiModel;
import com.wordnik.swagger.annotations.ApiModelProperty;

/**
 * test-main-manager-v3.0
 * Created by xian.juanjuan on 2016-11-18 09:28.
 */
@ApiModel(description = "test-main-manager-v3.0   Created by xian.juanjuan on 2016-11-18 09:28.")
public class TestSwaggerModelDoc {

    /**
     * 用户ID
     */
    @ApiModelProperty(value = "用户ID")
    private String userId;

    /**
     * 用户名称
     */
    @ApiModelProperty(value = "用户名称")
    private String userName;

    /**
     * 获取 用户ID
     */
    public String getUserId() {
        return this.userId;
    }

    /**
     * 设置 用户ID
     */
    public void setUserId(String userId) {
        this.userId = userId;
    }

    /**
     * 获取 用户名称
     */
    public String getUserName() {
        return this.userName;
    }

    /**
     * 设置 用户名称
     */
    public void setUserName(String userName) {
        this.userName = userName;
    }
}



你可能感兴趣的:(开发工具类)