当前位置: 首页 > 工具软件 > Swagger > 使用案例 >

整合SpringFox-Swagger 和 swagger-ui

陆翔飞
2023-12-01

1、 在pom.xml文件中引入依赖

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

2、新建swag配置文件 在代码中新定义一个类,代码如下

package com.htjf.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@ComponentScan(basePackages= {"com.htjf.controller"})
@EnableWebMvc
public class SwaggerConfig {

	@Bean
	public Docket api() {
		return new Docket(DocumentationType.SWAGGER_2)
				.select()
				.apis(RequestHandlerSelectors.any())
				.build()
				.apiInfo(apiInfo());
	}
	
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("对外开放接口API 文档")               //大标题 title
				.description("HTTP对外开放接口")             //小标题
				.version("1.0.0")                           //版本
				.termsOfServiceUrl("http://xxx.xxx.com")    //终端服务程序
				.license("LICENSE")                         //链接显示文字
				.licenseUrl("http://xxx.xxx.com")           //网站链接
				.build();
	}
}

3、在自己的controller中使用

@RestController
public class MyController {
    @RequestMapping(value = "hello", method = RequestMethod.GET)
    public String hello() {
        return "hello";
    }
}

4、如上的配置就可以了,下面是展示效果 在本地启动项目,然后浏览器输入:

http://localhost:8080/swagger-ui.html

 类似资料: