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

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

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

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

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

如何實(shí)現(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 加入配置

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

2.增加一個(gè)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實(shí)現(xiàn)方式的詳細(xì)內(nèi)容，更多關(guān)于Springboot集成swagger的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章:

相關(guān)文章

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