SpringBoot開啟Swagger并配置基本信息方式

更新時(shí)間：2024年05月22日 12:11:12 作者：yui方木

這篇文章主要介紹了SpringBoot開啟Swagger并配置基本信息方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

前后端分離：前后端交互：API

前后端集成聯(lián)調(diào)，前后端人員無法及時(shí)協(xié)商

解決方案

首先制定schema[計(jì)劃的提綱]，實(shí)時(shí)更新最新API，降低集成風(fēng)險(xiǎn)
Swagger

Swagger

世界上最流行的API框架
Restful API 文檔在線自動(dòng)生成工具–>API文檔與API定義同步更新
可以在線直接運(yùn)行，直接測(cè)試
支持多種語言：Java、PHP…

在項(xiàng)目中使用swagger：springfox

swagger2
ui

Springboot集成Swagger

導(dǎo)包：

<!-- swagger -->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<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>

配置swagger：

package com.example.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
/**開啟Swagger2*/
@EnableSwagger2
public class SwaggerConfig {

}

然后就可以訪問swagger頁面：

/swagger-ui.html

配置swagger

進(jìn)ApiInfo這個(gè)類看看，有什么Api配置屬性：

SwaggerConfig配置類：

配置ApiInfo：

@Configuration
/*開啟Swagger2*/
@EnableSwagger2 /* :/swagger-ui.html */
public class SwaggerConfig {
//配置Swagger的Docket的bean實(shí)例
@Bean
public Docket docket(){
//配置文檔信息
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

//配置apiinfo
private ApiInfo apiInfo(){

//作者信息
Contact contact = new Contact("fzl","https://blog.csdn.net/weixin_44976835","1403275028@qq.com");

return new ApiInfo(

"Epidemic Swagger",
"fzl最帥",
"1.0",
"https://blog.csdn.net/weixin_44976835",
contact,
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList()
);

}
}

可以配置swagger-ui.html頁面信息，配置完變成了：

沒什么大用，就是更改一個(gè)文檔說明，還能標(biāo)注個(gè)作者什么的^ .^

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

相關(guān)文章

java分布式流處理組件Producer入門詳解
這篇文章主要為大家介紹了java分布式流處理組件Producer入門詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪
2023-03-03
MyBatis批量插入大量數(shù)據(jù)(1w以上)
MyBatis進(jìn)行批量插入數(shù)時(shí)，一次性插入超過一千條的時(shí)候MyBatis開始報(bào)錯(cuò)，本文主要介紹了MyBatis批量插入大量數(shù)據(jù)的解決方法，感興趣的可以了解一下
2022-01-01
通過實(shí)例了解Spring中@Profile的作用
這篇文章主要介紹了通過實(shí)例了解Spring中@Profile的作用,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
2019-11-11
通過Spring AOP實(shí)現(xiàn)異常捕捉機(jī)制
在開發(fā)過程中,異常處理是一個(gè)不可忽視的重要環(huán)節(jié),合理、優(yōu)雅地處理異常不僅能提高代碼的魯棒性,還能提升系統(tǒng)的用戶體驗(yàn),本文將介紹如何通過Spring AOP實(shí)現(xiàn)一個(gè)高效的異常捕捉機(jī)制,使得異常處理變得更加優(yōu)雅和統(tǒng)一,需要的朋友可以參考下
2024-08-08
Spring Boot日志控制詳解
這篇文章主要為大家詳細(xì)介紹了Spring Boot日志控制的相關(guān)資料，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下
2017-11-11
Eclipse最新版使用過程中遇到的問題總結(jié)
這篇文章主要介紹了Eclipse最新版使用過程中遇到的問題總結(jié)的相關(guān)資料,本文通過圖文并茂的形式給大家介紹的非常詳細(xì)，具有參考借鑒價(jià)值，需要的朋友可以參考下
2016-09-09
Spring 使用 feign時(shí)設(shè)置header信息的操作
這篇文章主要介紹了Spring 使用 feign時(shí)設(shè)置header信息的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
2021-08-08
Netty源碼分析NioEventLoop處理IO事件相關(guān)邏輯
這篇文章主要介紹了Netty源碼分析NioEventLoop處理IO事件相關(guān)邏輯，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪
2022-03-03
詳解Mybatis極其(最)簡(jiǎn)(好)單(用)的一個(gè)分頁插件
這篇文章主要介紹了詳解Mybatis極其(最)簡(jiǎn)(好)單(用)的一個(gè)分頁插件,非常具有實(shí)用價(jià)值，需要的朋友可以參考下。
2016-12-12
java判斷對(duì)象中某個(gè)屬性是否為空方法代碼
這篇文章主要給大家介紹了關(guān)于java判斷對(duì)象中某個(gè)屬性是否為空的相關(guān)資料,最近遇到后臺(tái)接收值的時(shí)候,需要對(duì)接收對(duì)象進(jìn)行非空校驗(yàn),需要的朋友可以參考下
2023-07-07