一、建立在spring-boot 2.7.3 下,pom 文件的引入依赖是如下:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
二、创建swagger的配置类
package com.zjy.springboot.myconfig;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger {
/**
* 创建API应用
* apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.zjy.springboot.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中)
* 访问地址:http://项目实际地址/swagger-ui.html
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("TY-Java-JY-2202(Spring Boot2中使用Swagger2构建RESTful APIs)")
.description("千锋·太原·Java2202")
.termsOfServiceUrl("http://www.qfedu.com")
.contact(new Contact("能源互联网大厦6F","https://www.qfedu.com","yunfei.ji@aliyun.com"))
.version("1.0")
.build();
}
}
三、创建实例,controller
package com.zjy.springboot.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Api(tags = {"hello"})
public class HelloHandler {
@ApiOperation(value = "欢迎使用swagger")
@RequestMapping("/hello")
public String hello (@RequestParam("name")String name) {
return name;
}
}
四、application.yaml 需要配置以下内容
spring.mvc.pathmatch.matching-strategy=ant_path_matcher
项目跑起来
五、访问地址: