1.引入pom依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
2.启动类上加上注解
@EnableSwagger2
3.在每个controller类上加上注解,方便区分每一块的方法
@Api(tags = "看板页面")
4.在每个方法上加上注解
@ApiOperation(value = "测试", notes = "测试")
方便区分每个方法的作用
5.方法里加上注解,设置每个方法需要传的参数。可设置多个参数,用逗号分开。
@RequestParam(value = "name", required = false)
6.前端访问方式:端口号+地址
http://localhost:8081/swagger-ui.html#/
7.启动时报错:
Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException: Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.toString()" because the return value of "springfox.documentation.spi.service.contexts.Orderings.patternsCondition(springfox.documentation.RequestHandler)" is null
经查阅是由于SpringBoot版本和Swagger版本不兼容导致的
在application.properties中添加:
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
即可解決