1、pom依赖
<!-- swagger2 -->
<!--swagger本身不支持spring mvc的,springfox把swagger包装了一下,让他可以支持springmvc-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
2、添加一个配置类
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.test.demo.web"))
.build();
}
public ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("api接口说明")
.version("1.0.0")
.build();
}
}
3、Controller
@Controller
@Api(value = "webcontroller")
public class WebController {
@ApiOperation(value = "获取信息",notes = "获取信息1",httpMethod = "GET")
@GetMapping("/get")
@ResponseBody
public Object get(){
Map map = new HashMap();
map.put("key1","nihao");
map.put("key2","nishi");
return map;
}
}
4、访问
通过浏览器打开swagger-ui的web管理界面。
默认地址是IP:port/swagger-ui.html.
本地运行IP是127.0.0.1
5、常用注解
-
@Api()用于类;
表示标识这个类是swagger的资源 -
@ApiOperation()用于方法;
表示一个http请求的操作 -
@ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等) -
@ApiModel()用于类
表示对类进行说明,用于参数用实体类接收 -
@ApiModelProperty()用于方法,字段
表示对model属性的说明或者数据操作更改 -
@ApiIgnore()用于类,方法,方法参数
表示这个方法或者类被忽略 -
@ApiImplicitParam() 用于方法
表示单独的请求参数 -
@ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam
6、具体使用举例说明
@Api()
用于类;表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list
@Controller
@Api(value="用户controller",tags={"用户操作接口"})
public class WebController {
}
@ApiOperation()用于方法;表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组(视情况而用)
@ApiOperation(value = "获取信息",notes = "获取信息1",httpMethod = "GET")
@GetMapping("/get")
@ResponseBody
public Object get(){
Map map = new HashMap();
map.put("key1","nihao");
map.put("key2","nishi");
return map;
}
![](https://img-blog.csdnimg.cn/20200326153440782.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzIwMTc=,size_16,color_FFFFFF,t_70)
@ApiParam() 用于方法,参数
字段说明;表示对参数的添加元数据(说明或是否必填等)
name–参数名
value–参数说明
required–是否必填
@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {
@ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")
@GetMapping("/getUserInfo")
public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {
// userService可忽略,是业务逻辑
User user = userService.getUserInfo();
return user;
}
}
@ApiModel()
用于类 ;表示对类进行说明,用于参数用实体类接收
value–表示对象名
description–描述
都可省略
@ApiModelProperty()
用于方法,字段; 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiModel(value="user对象",description="用户对象user")
public class User implements Serializable{
private static final long serialVersionUID = 1L;
@ApiModelProperty(value="用户名",name="username",example="xingguo")
private String username;
@ApiModelProperty(value="状态",name="state",required=true)
private Integer state;
private String password;
private String nickName;
private Integer isDeleted;
@ApiModelProperty(value="id数组",hidden=true)
private String[] ids;
private List<String> idList;
//省略get/set
}
@ApiOperation("更改用户信息")
@PostMapping("/updateUserInfo")
public int updateUserInfo(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){
int num = userService.updateUserInfo(user);
return num;
}
@ApiIgnore()用于类或者方法上,可以不被swagger显示在页面上
@ApiImplicitParam() 用于方法,表示单独的请求参数
@ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam
name–参数ming
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明
@ApiOperation("查询测试")
@GetMapping("select")
//@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query")
@ApiImplicitParams({
@ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),
@ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})
public void select(){
}