Swagger简介
1.Swagger:基于Open API规范的一种工具,基于文档格式
2.Springfox:基于代码格式,舍弃文档格式
- swagger-springmvc
导入Swagger
-
添加依赖:springfox和swagger
-
在启动类上添加注解@EnableSwagger2
常用注解:
- Api(tags={"demo1"},description="描述"):作用于类上
- ApiOperation(value=”接口描述“,notes=“提示信息”):作用在方法上
- ApiParam(name:"",value:"",required:true):作用在方法参数上
- ApiModel(value="人实体类",description="实体类封装了所有"):作用在实体类上
- ApiModelProperty(value=“编号”,name=“id”,required=true,example="123",hidden=true):作用在实体类的属性和方法上
- ApiIgnore():使用在方法/类/参数上,表示被忽略
- ApiImplicitParam(name=”id“,value=”编号“,required=true,dataType=”string“,paramType=”body“):功能与@ApiParam类似,作用在方法上
- ApiImplicitParams(value={@ApiImplicitParam(),@ApiImplicitParam()})
页面查看Swagger API
在页面上输入ip:port/swagger-ui.html即可