Spring Boot 集成 Swagger2 构建 RESTful API 文档

创建 Swagger2Config 配置类

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.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
 return new Docket(documentationType.SWAGGER_2)
  .apiInfo(apiInfo())
  .select()
  .apis(RequestHandlerSelectors.basePackage("{Controler 扫描路径}"))
  .paths(PathSelectors.any())
  .build();
    }

    private ApiInfo apiInfo() {
 return new ApiInfoBuilder()
  .title("{标题}")
  .description("{描述}")
  .termsOfServiceUrl("{网址}")
  .version("{版本号}")
  .build();
    }
}

@EnableSwagger2
@SpringBootApplication
public class ServiceAdminApplication {
    public static void main(String[] args) {
 SpringApplication.run(ServiceAdminApplication.class, args);
    }
}

@RestController
@RequestMapping(value = "/api/v2/user")
@Api(tags = "用户管理")
public class UserController() {

	@ApiOperation(value = "分页查询用户列表")
	@ApiImplicitParams({
			@ApiImplicitParam(name = "pageNum", value = "页码", required = true, dataType = "int", paramType = "path"),
			@ApiImplicitParam(name = "pageSize", value = "页数", required = true, dataType = "int", paramType = "path"),
			@ApiImplicitParam(name = "UserJson", value = "对象 JSON 字符串", required = false, dataTypeClass = String.class, paramType = "json")
	})
	@RequestMapping(value = "page/{pageNum}/{pageSize}", method = RequestMethod.GET)
	public baseResult page(
		@PathVariable(required = true) int pageNum, 
		@PathVariable(required = true) int pageSize,
		@RequestParam(required = false) String UserJson
	){
		return null;
	}
}