springboot集成swagger

swagger 接口文档描述，提供ui可以方便的调试自己的接口，是非常不错的一个工具包，这里介绍一下如何集成及在配置过程中遇到的坑！

maven依赖

 <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>

 配置swagger

package com.channelsoft;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class Swagger2 {

	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.channelsoft.controller"))
				.paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				//页面标题
				.title("Spring Boot Swagger2 构建RESTful API")
				//条款地址
				.termsOfServiceUrl("https://blog.csdn.net/nanruitao10")
				.contact(new Contact("nanrt","https://blog.csdn.net/nanruitao10","1686886012@qq.com"))
				.version("1.0")
				//描述
				.description("API 描述")
				.build();

	}
}

添加测试controller

@RestController
@Slf4j
@Api(description = "swagger描述文档示例")
@RequestMapping(value = "/hello")
public class HelloController {
	@ApiOperation(value = "获取值", notes = "提示接口使用者注意事项")
	@RequestMapping(value = "/query", method = RequestMethod.GET)
	public String hello() {
		log.debug("进入到controller的hello()方法");
		return "hello Spring Cloud";
	}

	@ApiOperation(value = "保存值", notes = "保存值")
	@RequestMapping(value = "/saveHello", method = RequestMethod.POST)
	public void saveHello(HelloPo helloPo) {

	}
}

启动springboot项目访问swagger地址http://localhost:9090/springcloud/swagger-ui.html#/hello-controller，如下图

到此就配置成功了！

遇到的问题：No operations defined in spec!

排查如下：

1. 首先看swagger的扫描路径是否正确，具体为
2. 若是正确还是包错，这要检查controller类中的方法是否添加@RequestMapping，若是没有添也会报错
3. 是否使用@ApiIgnore