SpringBoot集成Swagger3的實(shí)現(xiàn)

更新時(shí)間：2021年12月29日 11:43:08 作者：在奮斗的大道

本文主要介紹了SpringBoot集成Swagger3的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

一，什么是swagger?

1,? Swagger 是一個(gè)規(guī)范和完整的文檔框架，

? ? 用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)文檔

? ? 官方網(wǎng)站:https://swagger.io/

2，使用swagger要注意的地方:

? ? ?在生產(chǎn)環(huán)境中必須關(guān)閉swagger,

? ? ?它本身只用于前后端工程師之間的溝通,

? ? ?可以專門使用一臺內(nèi)部服務(wù)器來展示ui供訪問,

? ? ?即使在這上面要做好安全措施

3,? 因?yàn)閟wagger3.0.0已發(fā)布，本文使用了最新版

? ? ?如果有還在用2.x版本的請參考時(shí)注意區(qū)分

二，SpringBoot 集成swagger3

?pom.xml 集成Swagger3依賴

        <!-- swagger3 接口文檔生成器 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Swagger3 配置對象定義

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
 
@Configuration
@EnableOpenApi
public class Swagger3Config {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("在奮斗的大道上 - 微信預(yù)約查檔系統(tǒng)").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }
 
}

SpringBoot 集成Swagger3 接口文檔效果截圖