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)用,省去了準備復(fù)雜的調(diào)用參數(shù)的過程。
- 還可以將文檔規(guī)范導(dǎo)入相關(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)文章!
您可能感興趣的文章:
- springboot2.6.4集成swagger3.0遇到的坑及解決方法
- SpringBoot集成Swagger3的實現(xiàn)
- springboot集成Swagger的方法(讓你擁有屬于自己的api管理器)
- Java SpringBoot詳解集成以及配置Swagger流程
- 關(guān)于springboot集成swagger3時spring-plugin-core報錯的問題
- 解決springboot集成swagger碰到的坑(報404)
- 教你利用springboot集成swagger并生成接口文檔
- 關(guān)于springboot集成swagger及knife4j的增強問題
- springBoot詳解集成Swagger流程
相關(guān)文章
分布式系統(tǒng)下調(diào)用鏈追蹤技術(shù)面試題
這篇文章主要為大家介紹了分布式系統(tǒng)下調(diào)用鏈追蹤技術(shù)面試問題合集,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步早日升職加薪2022-03-03
淺談Java 類中各成分加載順序和內(nèi)存中的存放位置
下面小編就為大家?guī)硪黄獪\談Java 類中各成分加載順序和內(nèi)存中的存放位置。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-02-02
Junit 5中@ParameterizedTest與@EnumSource結(jié)合使用
今天小編就為大家分享一篇關(guān)于Junit 5中@ParameterizedTest與@EnumSource結(jié)合使用,小編覺得內(nèi)容挺不錯的,現(xiàn)在分享給大家,具有很好的參考價值,需要的朋友一起跟隨小編來看看吧2018-12-12
Java圖書管理系統(tǒng),課程設(shè)計必用(源碼+文檔)
本系統(tǒng)采用Java,MySQL 作為系統(tǒng)數(shù)據(jù)庫,重點開發(fā)并實現(xiàn)了系統(tǒng)各個核心功能模塊,包括采編模塊、典藏模塊、基礎(chǔ)信息模塊、流通模塊、期刊模塊、查詢模塊、評論模塊、系統(tǒng)統(tǒng)計模塊以及幫助功能模塊2021-06-06

