Swagger2使用
文章目录
SSM整合Swagger2
1 介绍
Swagger是一套围绕OpenAPI规范构建的开源工具,可以帮助您设计,构建,记录和使用REST API。
swagger 能够根据代码中的注释自动生成 api 文档,并且提供测试接口。
2 用法
- 引入依赖
- 配置类SwaggerConfig.java
@Bean:交给spring管理
Docket:swagger2的核心对象
配置docket: - spring-web.xml中配置
- 测试
过滤器放开路径/swagger-ui.html,/webjars/**
controller下写个测试:
@Controller
@API(tags=“API测试”,value=“测试类”)
…
@GetMapping("")
@ResponseBody
@ApiOperation(tags=“测试方法”,value=“xxx”)
@ApiImplicitParam(paramType=“query”,name=“id”,value=“数据id”,required=true,dataType=“int”)
// 两个参数就用@ApiImplicitParams({ @ApiIm… , @ApiIm… })
…
3 注解解释
@ApiImplicitParam参数: