现在项目中都是使用前端后台分离的开发方式,而使两者紧密联系着的就是API文档了,swagger就是一个很好的生成API文档的工具。
首先在项目中导入swagger相关的依赖
使用@Configuration注解,创建一个swagger配置类,并使用@EnableSwagger2注解开启swagger
生成Docket和ApiInfo这两个对象
在controller类上使用注解:
@Api(value = "/", description = "")
在controller类中的方法上使用注解
@ApiOperation(value = "查询公司集合 ", produces = "application/json") @RequestMapping(value = "/getCompanyList", method = { RequestMethod.POST, RequestMethod.GET }) @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "sequence", dataType = "String", required = true,
value = "流水号,必填")})
最后访问生成的api文档:
http://localhost:8080/swagger-ui.html进行访问调试