swagger2
<!-- 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>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
配置:
package com.itfly.conf;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;
/**
* Swagger2配置类
* 在与spring boot集成时,放在与Application.java同级的目录下。
* 或者通过 @Import 导入配置
*/
@Configuration
@EnableSwagger2 //开启swagger2,若启动类上添加了该注解,则配置类可以不添加
public class SwaggerConfig {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
* @return
*/
@Bean
public Docket createRestApi() {
// Docket是swagger全局配置对象
// DocumentationType:指定文档类型为swagger2
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.build();
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中)
* 访问地址:http://项目实际地址/swagger-ui.html 或者 http://项目实际地址/doc.html
* @return
*/
private ApiInfo apiInfo() {
// 作者信息
Contact contact = new Contact(
// 文档发布者的名称
"yyf",
// 文档发布者的网站地址
"",
// 文档发布者的电子邮箱
"3559758172@qq.com"
);
return new ApiInfoBuilder()
//标题
.title("农场")
//文本描述
.description("农场")
//服务组url地址
.termsOfServiceUrl("")
//执照
.license("个人版权")
//作者信息
.contact(contact)
//版本号
.version("1.0")
.build();
}
}
swagger3
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
配置:
package com.gcxy.config;
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class SwaggerConfig {
//Swagger实例bean是Docket,所以通过配置Docket实例来配置Swagger(创建Docket实例放入Spring容器中)
//Swagger的访问地址http://localhost:8080/swagger-ui/
//http://localhost:8080/doc.html
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())//设置api文档相关信息
.select()
.apis(RequestHandlerSelectors.basePackage("com.gcxy.controller"))//配置Swagger指定要扫描的包
.paths(PathSelectors.ant("/**/**"))//通过请求路径经过Swagger扫描的接口
.build();
}
/***
* 配置api文档信息
* @return ApiInfo对象
*/
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("综合使用Restful请求、Swagger、自定义转换器和自定义拦截器")
.description("综合使用Restful请求、Swagger、自定义转换器和自定义拦截器")
.termsOfServiceUrl("http://localhost:8080")
.version("1.0")
.build();
}
}