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

 更新时间:2023年05月17日 10:44:26   作者:shenzhenNBA  
这篇文章主要介绍了Java使用Swagger接口框架方法,Swagger是一个方便我们更好的编写API文档的框架,而且Swagger可以模拟http请求调用,感兴趣的同学可以参考下文

一,Swagger功能是什么呢

简单说就是生产API接口文档,同时提供在线调试项目API的接口的功能,可以说对推进项目进度非常有利,尤其对前后台分离的情况更加有用;

二,如何在Java项目中使用Swagger功能

(欢迎使用推荐的方式)

1,过去的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相关的html,css,JS和图片(jpg,png,gif等),然后在项目使用,例如:http://localhost:8080/swagger-ui.html(另一种调试方式是http://localhost:8080/doc.html

2,Springdoc方式使用Swagger功能

——推荐使用

过去的方式也许还是有点繁琐,是时候换Springdoc方式使用Swagger功能了,当然这个也是基于Swagger2.x实现,它完美支持SpringBoot 1.x/2.x,Swagger-ui也比较好看,其它次要的暂时忽略;然后在项目中增加依赖 jar 包,

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

在下载这些 JAR包时,如果是从国外官方的可能耗时间比较久,可以修改maven仓库的配置文件,修改如下:

<!-- 阿里的公开maven库,在 mirrors标签的内部追(增)加如下内容 -->
<mirrors>
	<mirror>  
	   <id>alimaven</id>  
	   <name>aliyun maven</name>  
	   <url>http://maven.aliyun.com/nexus/content/groups/public/</url>  
	   <mirrorOf>central</mirrorOf>          
	</mirror>
</mirrors>

从国内的ali的镜像仓库中下载,速度要快蛮多;记住,然后什么都不用做了,启动项目,直接可根据项目访问Swagger功能了,访问URL格式:http://ip:port/swagger-ui.html

例如我的:http://127.0.0.1/swagger-ui.html 很直观看到API接口,同时通过 “try it out” 可直接在线调试了,非常方便快速... 看看一下部分截图:

三,后记

basic-error-controller 这些API是自动生成的,可以不理,仅关注自己开发的API接口即可,总之,使用springdoc这种方式使用swagger功能,非常方便,简单,快速,可以快速查看项目各个API文档,同时非常方便在线调试,尤其是对前后端分离的项目更加有利推进项目进度,可能有些考虑不周

到此这篇关于Java使用Swagger接口框架方法详解的文章就介绍到这了,更多相关Java使用Swagger内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 128进制加密数据示例分享

    128进制加密数据示例分享

    这篇文章主要介绍了128进制加密数据示例,这里使用JAVA实现,需要的朋友可以参考下
    2014-03-03
  • java:程序包javax.servlet.http不存在问题解决

    java:程序包javax.servlet.http不存在问题解决

    这篇文章主要给大家介绍了关于java:程序包javax.servlet.http不存在问题解决的相关资料,如果引用的包依赖的库文件缺失或版本不匹配,就会导致"Java 程序包不存在"的错误,需要的朋友可以参考下
    2023-10-10
  • Java中forEach使用lambda表达式,数组和集合的区别说明

    Java中forEach使用lambda表达式,数组和集合的区别说明

    这篇文章主要介绍了Java中forEach使用lambda表达式,数组和集合的区别说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • mybatis if test 不为空字符串且不为null的问题

    mybatis if test 不为空字符串且不为null的问题

    这篇文章主要介绍了mybatis if test 不为空字符串且不为null的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • 简易JDBC框架实现过程详解

    简易JDBC框架实现过程详解

    这篇文章主要介绍了简易JDBC框架实现过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • String StringBuilder StringBuffer区别以及源码分析

    String StringBuilder StringBuffer区别以及源码分析

    string是C++标准库的一个重要的部分,主要用于字符串处理。可以使用输入输出流方式直接进行string操作,同时,C++的算法库对string类也有着很好的支持,并且string类还和c语言的字符串之间有着良好的接口
    2021-06-06
  • 利用java和sqlserver建立简易图书管理系统的完整步骤

    利用java和sqlserver建立简易图书管理系统的完整步骤

    图书馆管理系统是图书馆管理工作中不可缺少的部分,它对于图书馆的管理者和使用者都非常重要,下面这篇文章主要给大家介绍了关于利用java和sqlserver建立简易图书管理系统的完整步骤,需要的朋友可以参考下
    2022-06-06
  • Java实现Excel数据验证功能

    Java实现Excel数据验证功能

    在Java中,开发者可以使用一些开源的库(如Apache POI)来添加、修改和处理Excel中的数据,下面我们就来看看如何使用Java实现添加,修改和删除Excel数据验证吧
    2023-10-10
  • 关于SpringBoot创建存储令牌的媒介类和过滤器的问题

    关于SpringBoot创建存储令牌的媒介类和过滤器的问题

    这篇文章主要介绍了SpringBoot创建存储令牌的媒介类和过滤器的问题,需要在配置文件中,添加JWT需要的密匙,过期时间和缓存过期时间,具体实例代码参考下本文
    2021-09-09
  • Java的设计模式之代理模式使用详解

    Java的设计模式之代理模式使用详解

    这篇文章主要介绍了Java的设计模式之代理模式使用详解,代理模式是23种设计模式之一,它关心的主要是过程,而不是结果,代理模式主要提供了对目标对象的间接访问方式,即通过代理对象来访问目标对象,需要的朋友可以参考下
    2024-01-01

最新评论