快捷導(dǎo)航

Java使用Swagger接口框架方法詳解

更新時(shí)間：2023年05月17日 10:44:26 作者：shenzhenNBA

這篇文章主要介紹了Java使用Swagger接口框架方法，Swagger是一個(gè)方便我們更好的編寫API文檔的框架，而且Swagger可以模擬http請(qǐng)求調(diào)用，感興趣的同學(xué)可以參考下文

一，Swagger功能是什么呢

簡(jiǎn)單說(shuō)就是生產(chǎn)API接口文檔，同時(shí)提供在線調(diào)試項(xiàng)目API的接口的功能，可以說(shuō)對(duì)推進(jìn)項(xiàng)目進(jìn)度非常有利，尤其對(duì)前后臺(tái)分離的情況更加有用；

二，如何在Java項(xiàng)目中使用Swagger功能

（歡迎使用推薦的方式）

1，過(guò)去的Swagger使用方式

——不推薦使用

（1）引入依賴 jar 包，如下:

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

（2）配置Swagger2Config.java

 
package com.qyh.pro01.config;
import java.io.Serializable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * Swagger配置類
 */
@Configuration
@EnableSwagger2 
public class Swagger2Config implements Serializable {
	private static final long serialVersionUID = 202002161810010L;
	@Bean
	public Docket api() {
		return new Docket(DocumentationType.SWAGGER_2)
			.apiInfo(apiInfo())
			.select()
			.apis(RequestHandlerSelectors.basePackage("com.xxx.yyy.controller"))
			.apis(Swagger2Config.basePackage("com.xxx.yyy.controller"))
			.paths(PathSelectors.any())
			.build();			
	}
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("Swagger2-api文檔")
				.description("Swagger2接口教程")
				.termsOfServiceUrl("http://www.baidu.com")
				.version("1.0.0")
				.contact(new Contact("shenzhenNBA", 
						"http://www.xxx.com", 
						"qyhzqw@163.com"))
				.build();
	}
}

還有些可能需要springMVC配置文件排除放行Swagger相關(guān)的html，css，JS和圖片(jpg，png，gif等），然后在項(xiàng)目使用，例如：http://localhost:8080/swagger-ui.html（另一種調(diào)試方式是http://localhost:8080/doc.html）

2，Springdoc方式使用Swagger功能

——推薦使用

過(guò)去的方式也許還是有點(diǎn)繁瑣，是時(shí)候換Springdoc方式使用Swagger功能了，當(dāng)然這個(gè)也是基于Swagger2.x實(shí)現(xiàn)，它完美支持SpringBoot 1.x/2.x，Swagger-ui也比較好看，其它次要的暫時(shí)忽略；然后在項(xiàng)目中增加依賴 jar 包，

<dependency>
	<groupId>org.springdoc</groupId>
	<artifactId>springdoc-openapi-ui</artifactId>
	<version>1.2.30</version> 
	<!-- 版本可自行選擇最新版本-->
</dependency

在下載這些 JAR包時(shí)，如果是從國(guó)外官方的可能耗時(shí)間比較久，可以修改maven倉(cāng)庫(kù)的配置文件，修改如下：

<!-- 阿里的公開maven庫(kù)，在 mirrors標(biāo)簽的內(nèi)部追（增）加如下內(nèi)容 -->
<mirrors>
	<mirror>  
	   <id>alimaven</id>  
	   <name>aliyun maven</name>  
	   <url>http://maven.aliyun.com/nexus/content/groups/public/</url>  
	   <mirrorOf>central</mirrorOf>          
	</mirror>
</mirrors>

從國(guó)內(nèi)的ali的鏡像倉(cāng)庫(kù)中下載，速度要快蠻多；記住，然后什么都不用做了，啟動(dòng)項(xiàng)目，直接可根據(jù)項(xiàng)目訪問(wèn)Swagger功能了，訪問(wèn)URL格式：http://ip:port/swagger-ui.html ，

例如我的：http://127.0.0.1/swagger-ui.html 很直觀看到API接口，同時(shí)通過(guò) “try it out” 可直接在線調(diào)試了，非常方便快速... 看看一下部分截圖：

三，后記

basic-error-controller 這些API是自動(dòng)生成的，可以不理，僅關(guān)注自己開發(fā)的API接口即可，總之，使用springdoc這種方式使用swagger功能，非常方便，簡(jiǎn)單，快速，可以快速查看項(xiàng)目各個(gè)API文檔，同時(shí)非常方便在線調(diào)試，尤其是對(duì)前后端分離的項(xiàng)目更加有利推進(jìn)項(xiàng)目進(jìn)度，可能有些考慮不周

到此這篇關(guān)于Java使用Swagger接口框架方法詳解的文章就介紹到這了,更多相關(guān)Java使用Swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: