Springboot集成swagger實現(xiàn)方式

更新時間：2021年08月31日 17:02:19 作者：Shaun_code

這篇文章主要介紹了Springboot集成swagger實現(xiàn)方式，通過簡單的示例代碼詳細描述了實現(xiàn)過程步驟，有需要的朋友可以借鑒參考下，希望可以有所幫助

Swagger 提供了一個全新的維護 API 文檔的方式，有4大優(yōu)點：

自動生成文檔：只需要少量的注解，Swagger 就可以根據(jù)代碼自動生成 API 文檔，很好的保證了文檔的時效性。
跨語言性，支持 40 多種語言。
Swagger UI 呈現(xiàn)出來的是一份可交互式的 API 文檔，我們可以直接在文檔頁面嘗試 API 的調(diào)用，省去了準備復雜的調(diào)用參數(shù)的過程。
還可以將文檔規(guī)范導入相關(guān)的工具（例如 SoapUI）, 這些工具將會為我們自動地創(chuàng)建自動化測試。

如何實現(xiàn)swagger

一： pom文件加入依賴包

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

二：修改配置文件

1.application.properties 加入配置

#表示是否開啟 Swagger，一般線上環(huán)境是關(guān)閉的
spring.swagger2.enabled=true

2.增加一個swagger配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value(value = "${spring.swagger2.enabled}")
    private Boolean swaggerEnabled;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(swaggerEnabled)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.swagger.boot"))//包名代表需要生成接口文檔的目錄包。
                .paths(PathSelectors.any())
                .build();
    }
     private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文檔")
                .description(" Spring Boot")
                .version("1.0")
                .build();
    }
}

以上就是Springboot集成swagger實現(xiàn)方式的詳細內(nèi)容，更多關(guān)于Springboot集成swagger的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章:

相關(guān)文章

解決mybatis-plus-boot-starter與mybatis-spring-boot-starter的錯誤問題
本文主要講述了在使用MyBatis和MyBatis-Plus時遇到的綁定異常問題,通過排查和總結(jié),作者發(fā)現(xiàn)使用MyBatis-Plus?Boot?Starter可以解決這個問題,文章詳細對比了MyBatis-Plus?Boot?Starter和MyBatis?Spring?Boot?Starter的功能和使用場景
2025-01-01
java Springboot實現(xiàn)多文件上傳功能
這篇文章主要為大家詳細介紹了java Springboot實現(xiàn)多文件上傳功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2018-08-08
Spring深入了解常用配置應用
這篇文章主要給大家介紹了關(guān)于Spring的常用配置,文中通過示例代碼介紹的非常詳細,對大家學習或者使用springboot具有一定的參考學習價值,需要的朋友可以參考下
2022-07-07
Mybatis plus的自動填充與樂觀鎖的實例詳解（springboot）
這篇文章主要介紹了Mybatis plus的自動填充與樂觀鎖的實例詳解（springboot）,本文給大家介紹的非常詳細對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2020-11-11
解析Spring Data JPA的Audit功能之審計數(shù)據(jù)庫變更
Spring Data JPA 提供了Audit審計功能，用來記錄創(chuàng)建時間、創(chuàng)建人、修改時間、修改人等，下面來詳細講解下審計數(shù)據(jù)庫變更
2021-06-06
詳細講解Java中的main()方法
在java中main()方法是java應用程序的入口方法，由此可見main方法是很重要的，那么下面這篇文章就給大家詳解介紹了Java中的main()方法,需要的朋友可以參考下。
2016-09-09
SpringBoot使用Maven打包異常-引入外部jar的問題及解決方案
這篇文章主要介紹了SpringBoot使用Maven打包異常-引入外部jar,需要的朋友可以參考下
2020-06-06
Spring Security 使用 OncePerRequestFilter
OncePerRequestFilter是一個過濾器,每個請求都會執(zhí)行一次；一般開發(fā)中主要是做檢查是否已登錄、Token是否過期和授權(quán)等操作,而每個操作都是一個過濾器,下面介紹Spring Security 使用 OncePerRequestFilter 過濾器校驗登錄過期、請求日志等操作方法,感興趣的朋友一起看看吧
2024-06-06
java 實現(xiàn)最小二叉樹堆排序的實例
這篇文章主要介紹了java 實現(xiàn)最小二叉樹堆排序的實例的相關(guān)資料,希望通過本文能幫助到大家，需要的朋友可以參考下
2017-09-09
詳解Spring框架下向異步線程傳遞HttpServletRequest參數(shù)的坑
這篇文章主要介紹了詳解Spring框架下向異步線程傳遞HttpServletRequest參數(shù)的坑，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2019-03-03