SpringBoot项目中集成Swagger2，阿里面试java准备

public class SwaggerConfig {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

// 当前包的路径

.apis(RequestHandlerSelectors.basePackage(“com.riemann.springbootdemo”))

// 可以根据url路径设置哪些请求加入文档，忽略哪些请求

.paths(PathSelectors.any())

.build();

}

// 构建api文档的详细信息函数,注意这里的注解引用的是哪个

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

// 页面标题

.title(“Spring Boot 使用 Swagger2 构建RESTful API”)

// 创建人

.contact(new Contact(“riemann”,“https://blog.csdn.net/riemann_”,“754798352@qq.com”))

// 版本号

.version(“1.0”)

// 描述

.description(“API 描述”)

.build();

}

}

如上代码所示，通过 @Configuration 注解，让 Spring 加载该配置类。再通过 @EnableSwagger2 注解来启用Swagger2。成员方法 createRestApi函数创建 Docket 的Bean之后，apiInfo() 用来创建该 Api 的基本信息（这些基本信息会展现在文档页面中）。select() 函数返回一个 ApiSelectorBuilder实例用来控制哪些接口暴露给 Swagger 来展现，本例采用指定扫描的包路径来定义，Swagger 会扫描该包下所有 Controller 定义的 API，并产生文档内容（除了被 @ApiIgnore 指定的请求）。

3、API 接口编写

在完成了上述配置后，其实已经可以产生文档内容，但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生