SpringBoot開(kāi)啟Swagger并配置基本信息方式
更新時(shí)間：2024年05月22日 12:11:12 作者：yui方木
這篇文章主要介紹了SpringBoot開(kāi)啟Swagger并配置基本信息方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
前后端分離：前后端交互：API
前后端集成聯(lián)調(diào)，前后端人員無(wú)法及時(shí)協(xié)商
解決方案
- 首先制定schema[計(jì)劃的提綱]，實(shí)時(shí)更新最新API，降低集成風(fēng)險(xiǎn)
- Swagger
Swagger
- 世界上最流行的API框架
- Restful API 文檔在線自動(dòng)生成工具–>API文檔與API定義同步更新
- 可以在線直接運(yùn)行，直接測(cè)試
- 支持多種語(yǔ)言：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
/**開(kāi)啟Swagger2*/
@EnableSwagger2
public class SwaggerConfig {
}
然后就可以訪問(wèn)swagger頁(yè)面：
/swagger-ui.html
配置swagger
進(jìn)ApiInfo這個(gè)類看看，有什么Api配置屬性：
SwaggerConfig配置類：
配置ApiInfo：
@Configuration
/*開(kāi)啟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頁(yè)面信息，配置完變成了：
沒(méi)什么大用，就是更改一個(gè)文檔說(shuō)明，還能標(biāo)注個(gè)作者什么的^ .^
總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot深入探究@Conditional條件裝配的使用
這篇文章主要為大家介紹了SpringBoot底層注解@Conditional的使用分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-06-06
Mybatis?大數(shù)據(jù)量批量寫(xiě)優(yōu)化的案例詳解
這篇文章主要介紹了Mybatis?大數(shù)據(jù)量批量寫(xiě)優(yōu)化的示例代碼，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-05-05
Java中LambdaQueryWrapper設(shè)置自定義排序代碼示例
這篇文章主要給大家介紹了關(guān)于Java中LambdaQueryWrapper設(shè)置自定義排序的相關(guān)資料,lambdaquerywrapper是MyBatis-Plus框架中的一個(gè)查詢條件構(gòu)造器,它可以用于構(gòu)建自定義的查詢條件,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了java中類之間的數(shù)據(jù)傳遞方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11
spring中FactoryBean中的getObject()方法實(shí)例解析
這篇文章主要介紹了spring中FactoryBean中的getObject()方法實(shí)例解析，分享了相關(guān)代碼示例，小編覺(jué)得還是挺不錯(cuò)的，具有一定借鑒價(jià)值，需要的朋友可以參考下2018-02-02
mybatis插件優(yōu)雅實(shí)現(xiàn)字段加密的示例代碼
在很多時(shí)候,我們都需要字段加密,比如郵箱,密碼,電話號(hào)碼等,本文主要介紹了mybatis插件優(yōu)雅實(shí)現(xiàn)字段加密的示例代碼,感興趣的可以了解一下2023-11-11
Java獲取時(shí)間差(天數(shù)差，小時(shí)差，分鐘差)代碼示例
這篇文章主要介紹了Java獲取時(shí)間差(天數(shù)差，小時(shí)差，分鐘差)代碼示例，使用SimpleDateFormat來(lái)實(shí)現(xiàn)的相關(guān)代碼，具有一定參考價(jià)值，需要的朋友可以了解下。2017-11-11
在平時(shí)我們做項(xiàng)目中，需要用到j(luò)ar包文件，有時(shí)候是不能從maven遠(yuǎn)程倉(cāng)庫(kù)拉取的，這時(shí)候就得考慮用到j(luò)ar文件安裝到本地maven庫(kù)中，再添加依賴，今天小編分步驟給大家介紹下SpringBoot 添加本地 jar 文件的流程，一起看看吧2021-09-09
Spring BeanPostProcessor(后置處理器)的用法
這篇文章主要介紹了Spring BeanPostProcessor(后置處理器)的用法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
mybatis-plus 關(guān)于savebatch,saveorupdatebatch遇到的坑及解決辦法
本文主要介紹了mybatis-plus 關(guān)于savebatch,saveorupdatebatch遇到的坑及解決辦法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-01-01