Swagger使用

Posted 2020-12-18 dagreentree

1、引入依赖

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.9.0.RELEASE</version>
</dependency>

2、启用注解

在启动类添加启用注解@EnableSwagger2Doc

3、分组

swagger.docket.controller.title=group-controller
swagger.docket.controller.base-package=com.mashibing.springboot.controller

swagger.docket.restcontroller.title=group-restcontroller
swagger.docket.restcontroller.base-package=com.mashibing.springboot.controller.rest

4、接口类描述

@Api(value = "用户权限管理",tags={"用户操作接口"})

5、接口方法

@ApiOperation(value = "添加权限")
@RequestMapping("update")
public RespStat update(@ApiParam(name="permission",required = true, example = "{json}",value = "权限对象") @RequestBody Permission permission) {	
	System.out.println("permission:" + ToStringBuilder.reflectionToString(permission));
	permissionSrv.update(permission);
	return RespStat.build(200);
}

6、实体模型

@ApiModelProperty(value = "权限id", name = "id",dataType = "integer",required = true,example = "1")
private Integer id;