在上一张的项目中创建SwaggerConfig，进行配置文档内容。
1 配置基本信息
Docket：摘要对象，通过对象配置描述文件的信息。
apiInfo:设置描述文件中info。参数类型ApiInfo
select():返回ApiSelectorBuilder对象，通过对象调用build()可以创建Docket对象
ApiInfoBuilder：ApiInfo构建器。
package com.example.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfiguration {
/**
* 创建Docket类型的对象。并使用spring容器管理。
* Docket是Swagger中的全局配置对象。
* @return
*/
@Bean
public Docket docket(){
Docket docket = new Docket(DocumentationType.SWAGGER_2);
// API帮助文档的描述信息。 information
ApiInfo apiInfo =
new ApiInfoBuilder()
.contact( // 配置swagger文档主体内容。
new Contact(
"不死鸟", // 是文档的发布者名称
"http://www.bjsxt.com", // 是文档发布者的网站地址。企业网站
"admin@bjsxt.com") // 文档发布者的电子邮箱
)
.title("swagger框架学习DEMO") //框架title
.description("Swagger框架学习帮助文档详细描述-Swagger框架是一个用于开发RestAPI帮助文档的框架") //框架描述
.version("1.1") //版本号
.build();
// 给docket上下文配置api描述信息。
docket.apiInfo(apiInfo);
return docket;
}
}
显示效果如下：
2 设置扫描的包
可以通过apis()方法设置哪个包中内容被扫描，直接对SwaggerConfig进行修改。
docket = docket
.select() // 获取Docket中的选择器。 返回ApiSelectorBuilder。构建选择器的。如：扫描什么包的注解。
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.build();
