springboot集成swagger2，构建优雅的Restful API

1. 引入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2. 创建Swagger2配置类

在Application.java同级创建Swagger2的配置类Swagger2。

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

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("springboot集成swagger2，构建优雅的Restful API")
				.description("springboot集成swagger2，构建优雅的Restful API，https://blog.csdn.net/fukaiit")
				.termsOfServiceUrl("https://blog.csdn.net/fukaiit")
				.version("1.0")
				.build();
	}
}

3. 编写生成文档的注解

都有什么常用注解？这里有详细说明：
https://blog.csdn.net/u014231523/article/details/76522486

例：

@RestController
@RequestMapping("/swagger2")
public class Swagger2TestController {

	@ApiOperation(value = "获取一个列表的方法", notes = "获取一个列表的方法说明")
	@GetMapping("/getList")
	public String getList() {
		return "获取一个列表";
	}

	@ApiOperation(value = "创建一个项目的方法", notes = "创建一个项目的方法说明")
	@ApiImplicitParam(name = "itemName", value = "需要新创建的项目", required = true, dataType = "string")
	@PostMapping("/createItem")
	public String createItem(@RequestBody String itemName) {
		return "创建了一个item";
	}
}

通过相关注解，就可以让swagger2生成相应的文档。如果你不需要某接口生成文档，只需要在加@ApiIgnore注解即可。需要说明的是，如果请求参数在url上，@ApiImplicitParam 上加paramType = “path” 。

4. 查看接口文档

启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html。