SpringBoot3整合SpringDoc实现在线接口文档

写在前面

在现目前项目开发中,一般都是前后端分离项目。前端小姐姐负责开发前端,苦逼的我们负责后端开发

事实是一个人全干,在这过程中编写接口文档就显得尤为重要了。然而作为一个程序员,最怕的莫过于自己写文档和别人不写文档

大家都不想写文档,那这活就交给今天的主角Swagger来实现了

一、专业名词介绍

OpenApi是什么?

解答:OpenApi是一个用于描述、定义和共享 RESTful API 文档的规范。最新规范是 OpenAPI 3.0

Swagger是什么?

解答: Swagger 是一个用于设计和测试 RESTful APIs 的工具。

它提供了API 描述、请求和响应示例、API 测试和文档生成等丰富的功能。最新版本是Swagger3,支持OpenAPI3.0规范

SpringFox 是什么?

SpringFox 是 Spring 社区维护的一个项目(非官方),帮助使用者将 Swagger 2 集成到 Spring 中。

目前国内项目使用的都是它

github地址:https://github.com/springfox/springfox

springDoc是什么?

解答: Spring-doc也是 Spring 社区维护的一个项目(非官方),帮助使用者将 Swagger 3 集成到 Spring 中

SpringDoc 支持 Swagger 页面 Oauth2 登录,相较于 SpringFox 而言,它的支撑时间更长,无疑是更好的选择

但是在国内发展较慢,网上一找资料,出来的基本上是 Swagger2的内容。

地址:https://springdoc.org/

OpenAPISpring-docSwagger 之间的关系

解答:OpenAPI 定义了一种标准的格式来表示 API 文档,而 Swagger 是一个实现 OpenAPI 规范的工具

二、Swagger详细简介

Swagger 江湖人称“丝袜哥”,是一个帮助程序员生成接口文档的利器。

只需要简单配置,就可以生成带有漂亮UI界面的接口文档,而且编写的接口代码变了

接口文档随之也跟着变,做到了真正的解放双手。

官网https://swagger.io/

Swagger 优点

  • 号称世界上最流行的API框架
  • Restful Api 文档在线自动生成器
  • 直接运行,支持在线测试API
  • 不仅仅支持Java,还支持多种语言(如:PHPPythonNode.js等)

三、小试牛刀

说了这么多Swagger 的优点,接下来就小试牛刀,看看怎么将Swagger集成到SpringBoot中。

3.1、环境介绍
  • JDK:17
  • SpringBoot:3.3.0
  • Springdoc

注: 细心的小伙伴可能已经发现了,在springboot3.0之前我用的都是Springfox来集成Swagger管理我们的API接口文档,

但是Springfox已经停止更新了,我们使用的是SpringBoot3 +jdk17 的环境后,Spring官网推荐了Springdoc 来整合swagger

3.2 新建一个springboot-web项目
3.3 添加依赖

由于篇幅原因,其他web项目相关依赖这里就不一一贴出来了。

第一个依赖是必须的,而且版本必须大于2.0.0

<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-ui</artifactId><version>2.2.0</version>
</dependency>
<dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-starter-webmvc-api</artifactId><version>2.2.0</version>
</dependency>

注:

我们这里使用的是jdk17+springboot3.3.0 环境,原来swaggerV2V3都不能用了,小伙伴们一定更要注意这儿

不能引入的依赖

如果引入上面错误的依赖,项目启动会报下面错误,这时候我们引入上面正确的依赖重新启动项目即可

报错信息

3.4 编写HelloController

新建一个controller包—>建立一个HelloController

新建Hellocontroller

@RestController
public class HelloController {@RequestMapping("/hello")public String hello(){return "hello";}
}

我们在浏览器中输入“http://localhost:8080/hello” 后回车,出现如下界面,说明我们的hello开发成功了

hello接口正常访问

3.5 访问swagger接口页面

:我们这里采用的是openapi ,所以就不用像swaggerV2v3那样添加配置类了

浏览器直接输入:http://localhost:8080/swagger-ui/index.html 回车即可看到下面界面

接口信息

整合swagger是不是很简单呢

四、修改接口

多种请求方式

从上面截图中我们看到,我们在HelloController 中只定义了一个接口,但是前端UI界面中出来个7种请求方式(GETPUTPOSTDELETEOPTIONSHEADPATCH)的接口,这是为什么呢?

解答:@RequestMapping("/hello") 我们接口中只是指定了访问地址,并没有指定请求方式

我们将注解修改成@RequestMapping(path = "/hello",method = RequestMethod.GET)

或者@GetMapping("/hello") 然后重启服务,我们看到界面上就只有一种请求方式的接口了

get请求方式

五、接口文档常用配置

5.1 配置访问路径

application.yml中可以自定义api-docsswagger-ui的访问路径。当然了,如果没配置,默认就是下面路径

springdoc:api-docs:path: /v3/api-docsswagger-ui:path: /swagger-ui.html
5.2 配置接口文档基本信息

① 配置接口基本信息

新建一个config包—>并在包下建立一个SpringDocConfig配置类

新建配置类

② 配置接口文档基础信息

我们在配置类中添加如下代码,

@Configuration
public class SpringDocConfig {@Beanpublic OpenAPI openAPI() {return new OpenAPI()// 配置接口文档基本信息.info(this.getApiInfo());}private Info getApiInfo() {return new Info()// 配置文档标题.title("SpringBoot3集成Swagger3")// 配置文档描述.description("SpringBoot3集成Swagger3示例文档")// 配置作者信息.contact(new Contact().name("程序员小凡").url("https://www.xiezhrspace.cn").email("1666397814@163.com"))// 配置License许可证信息.license(new License().name("Apache 2.0").url("https://www.xiezhrspace.cn"))// 概述信息.summary("SpringBoot3集成Swagger3示例文档aaa").termsOfService("https://www.xiezhrspace.cn")// 配置版本号.version("2.0");}}

前端页面访问接口文档页面后显示如下

接口基本信息

② 配置接口servers信息

接口可能存在多环境,如开发环境、测试环境、生产环境等

我们可以通过@OpenAPIDefinition 配合servers 属性来配置不同环境,具体配置示例如下

@OpenAPIDefinition(servers = {@Server(description = "开发环境服务器", url = "http://localhost:8080"),@Server(description = "测试环境服务器", url = "https://test.xiezhr.com")}
)
@Configuration
public class SpringDocConfig {//...
}

配置完成后,浏览器访问显示如下

配置servers信息

③ 配置外部文档信息

有时候我们需要在在线接口文档中可以显示跳转到API的一些外部文档(比如 项目部署文档等)

这个时候我们可以通过@OpenAPIDefinition 配合 externalDocs 属性来配置外部文档

具体配置如下

@OpenAPIDefinition(externalDocs = @ExternalDocumentation(description = "项目编译部署说明",url = "http://localhost:8080/deplay/readme.md")
)
@Configuration
public class SpringDocConfig {//......
}

配置完后重启服务,浏览器访问接口文档,显示如下

外部API文档

SpringDocConfig 类完整配置代码如下

@OpenAPIDefinition(servers = {@Server(description = "开发环境服务器", url = "http://localhost:8080"),@Server(description = "测试环境服务器", url = "https://test.xiezhr.com")},externalDocs = @ExternalDocumentation(description = "项目编译部署说明",url = "http://localhost:8080/deplay/readme.md")
)@Configuration
public class SpringDocConfig {@Beanpublic OpenAPI openAPI() {return new OpenAPI()// 配置接口文档基本信息.info(this.getApiInfo());}private Info getApiInfo() {return new Info()// 配置文档标题.title("SpringBoot3集成Swagger3")// 配置文档描述.description("SpringBoot3集成Swagger3示例文档")// 配置作者信息.contact(new Contact().name("程序员小凡").url("https://www.xiezhrspace.cn").email("1666397814@163.com"))// 配置License许可证信息.license(new License().name("Apache 2.0").url("https://www.xiezhrspace.cn"))//.summary("SpringBoot3集成Swagger3示例文档aaa").termsOfService("https://www.xiezhrspace.cn")// 配置版本号.version("2.0");}}

配置完上面信息后,重启服务,浏览器访问:http://localhost:8080/v3/swagger-ui/index.html

接口文档基本信息

5.3 配置扫描接口

应用场景:

有时候我们为了业务需要,我们建立了多个包下的接口,如admin包下的,common包下的接口,

为了安全起见,我们只允许接口文档中访问comm包下面的接口。

在不加任何配置的情况下,所以接口都会默认显示,具体如下

显示所有接口

配置扫描接口包:

application.yml中可以自定义要扫描的接口包

springdoc:packages-to-scan: com.xiezhr.swaggerdemo.common.controller

配置好之后重启服务,我们发现前台UI只显示了common包下面的接口了

只显示common包下面的接口

5.4 配置接口文档开关

使用场景:

为了接口安全,我们一般需要在测试(test)环境或者开发(dev)环境中开启接口文档,而在生产(prod)环境中 关闭接口文档

这个应该怎么做呢?

这里涉及到SpringBoot多环境配置,忘记的小伙伴可以翻一翻之前的文章。传送门:

我们创建三个配置文件,分别为

  • application-dev.yml 开发环境

  • application-test.yml 测试环境

  • application-prod.yml 生产环境

只需在①和②配置文件中添加如下配置

springdoc:api-docs:enabled: true

而③配置文件中添加

springdoc:api-docs:enabled: false

通过上面配置后,我们在开发和测试环境下:就能正常访问http://localhost:8080/v3/swagger-ui/index.html#/

而在生产环境下就无法访问,报如下错误

生产环境

5.5 配置API分组

为了演示API分组,我们在controller包下面再建立admin包和common包,包下分别添加AdminControllerCommonController接口类,结构及代码如下

包结构

AdminController

// AdminController
@RestController
@RequestMapping("/admin")
public class AdminController {@GetMapping("/index")public String  admin(){return "admin";}
}

CommonController

@RestController
@RequestMapping("/common")
public class CommonController {@GetMapping("/hello")public String hello(){return "hello";}
}

在默认情况(没有分组)的情况下,所有包下接口都显示在一一个默认组下面,如/common/* 和/admin/* 访问路径下的接口都显示在一起,如下图所示

默认分组

这时,如果/common/* 下的接口比较多,/admin/* 下的接口也比较多,界面上显示就很混乱

解决办法就是添加分组信息,我们在SpringDocConfig 配置类中添加如下代码,这样就把接口分为了"common通用模块组" 和"admin模块组" 两个组

@Bean("commonGroupApi")
public GroupedOpenApi webGroupApi() {return GroupedOpenApi.builder().group("common通用模块组").pathsToMatch("/common/**").build();
}@Bean("adminGroupApi")
public GroupedOpenApi adminGroupApi() {return GroupedOpenApi.builder().group("admin模块组").pathsToMatch("/admin/**").build();
}

重启服务,再访问http://localhost:8080/v3/swagger-ui/index.html 如下

API分组

5.6 配置接口信息

@Tag 注解使用

对一个 operation 进行说明或定义的标签,用在类或方法上,也可以用在 @OpenAPIDefinition 中定义标签。

常用参数:

  • name: 名称
  • description: 接口描述信息

示例:

用在类上

@RestController
@RequestMapping("/common")
@Tag(name = "公共接口", description = "公共接口")
public class CommonController {//......
}

@Operation 注解使用

用于说明方法用途,用在方法上。

参数:

  • summary:方法概要,方法的一个简单介绍,建议 120 个字符内
  • description:方法描述,一般是很长的内容
  • hidden:是否隐藏

示例:

@GetMapping("/hello")
@Operation(summary = "hello接口", description = "hello接口描述" ,hidden = true)
public String hello(){return "hello";
}

@Parameter注解使用

用于说明方法参数,用在方法参数上。

参数:

  • name:指定的参数名
  • in:参数位置,可选 queryheaderpathcookie,默认为空,表示忽略
  • description:参数描述
  • required:是否必填,默认为 false

示例:

@GetMapping("/user/{id}")
public User getUser( @Parameter(name = "id",in = ParameterIn.PATH,description = "用户ID",required = true) @PathVariable("id") Integer id){User user = userService.getUserById(id);return user;
}

前端页面查看

@Paramter注解配置信息

@ApiResponse 注解使用

用于说明一个响应信息,用在 @ApiResponses 中。

参数:

  • responseCode:HTTP 响应码
  • description:描述

示例:

@GetMapping("/user/{id}")
@Operation(summary = "获取用户信息", description = "根据用户ID获取用户信息")
@ApiResponses(value ={@ApiResponse(responseCode = "200", description = "请求成功"),@ApiResponse(responseCode = "404", description = "用户不存在")            
})
public User getUser( @Parameter(name = "id",in = ParameterIn.PATH,description = "用户ID",required = true) @PathVariable("id") Integer id){User user = userService.getUserById(id);return user;
}

@ApiResponse注解配置信息

完整配置

@RestController
@RequestMapping("/common")
@Tag(name = "公共接口", description = "公共接口")
public class CommonController {@Autowiredprivate IUserService userService;@GetMapping("/hello")@Operation(summary = "hello接口", description = "hello接口描述" ,hidden = true)public String hello(){return "hello";}@GetMapping("/hi")@Operation(summary = "hi接口", description = "hi接口描述")public String Hi(){return "Hi 程序员小凡";}@GetMapping("/user/{id}")@Operation(summary = "获取用户信息", description = "根据用户ID获取用户信息")@ApiResponses(value ={@ApiResponse(responseCode = "200", description = "请求成功"),@ApiResponse(responseCode = "404", description = "用户不存在")})public User getUser( @Parameter(name = "id",in = ParameterIn.PATH,description = "用户ID",required = true) @PathVariable("id") Integer id){User user = userService.getUserById(id);return user;}
}

重启后,浏览器访问http://localhost:8080/v3/swagger-ui/index.html 如下

image-20240615213336423

5.7 配置实体信息

① 新建一个User实体类

@Data
public class User {private String name;private Integer age;private String email;private String address;
}

@Schema标签使用

用于描述数据对象信息或数据对象属性,比如各种POJO类及属性,用在类或类属性上。

参数:

  • name:属性名称
  • description:属性描述
  • required:是否必须
  • minLength:字符最小长度
  • maxLength:字符最大长度

③使用示例:

@Data
@Schema(description = "用户实体类",name = "User")
public class User {@Schema(description = "用户名",name =  "name",minLength =  6,maxLength = 20,required = true)private String name;@Schema(description = "年龄",name =  "age",required = true,minimum = "1",maximum = "100")private Integer age;@Schema(description = "邮箱",name =  "email",required = true)private String email;@Schema(description = "地址",name =  "address")private String address;
}

④ 浏览器访问:http://localhost:8080/v3/swagger-ui/index.html ,我们看到配置的实体信息显示出来了

实体信息

六、接口调试

通过上面各种配置之后,我们的在线接口文档基本上生成得差不多了。接下来我们就来说说怎么使用在线接口文档进行接口测试

① 测试说明

在之前小节中我们开发了要给根据用户ID 获取用户信息的接口getUser。我们现在要做的就是在前端UI界面中找到这个接口,

在开发环境下输入用户ID值,然后获取用户信息。

② 选择组信息

【获取用户信息】这个接口在,common通用模块组下面,所以我们第一步就要前端UI界面右上角选择这个组

选择common通用模块组

② 选择开发环境

Servers 下选择配置好的开发环境

选择开发环境

找到我们要测试的接口

找到目标接口

④ 测试接口,获取响应数据

接口右边下三角箭头展开接口------>点击Try it out

点击Try it out

输入参数:用户ID------> 点击【Execute】----->在Response body 中查看接口响应信息

根据用户id获取到响应信息

七、添加请求头

很多时候我们接口都需要认证之后才能访问,这时候我们就需要接口调用的时候携带着Token信息

示例:

我们通过@RequestHeader 注解 获取请求头中token信息

@GetMapping("/index")
public String  admin(@RequestHeader ("token") String token){System.out.println("token>>>>>>>>>>>>>>>>>>>>>>>>"+token);//token 验证//.....各种业务逻辑return "admin";
}

添加请求头信息

到此,本期内容就结束了,★,°:.☆( ̄▽ ̄)/$:.°★ 。 希望对您有所帮助

我们下期再见 ヾ(•ω•`)o (●’◡’●)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/854710.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

找工作小项目:day16-重构核心库、使用智能指针(3)

day16-重构核心库、使用智能指针&#xff08;3&#xff09; 最后将使用这个库的方式进行展示。 1、客户端 在while ((o getopt(argc, argv, optstring)) ! -1)所有的操作都是获取参数的操作&#xff0c;threads 、msgs 和wait 分别指线程数、消息长度以及等待时间。 创建一…

【数据结构(邓俊辉)学习笔记】二叉搜索树02——查找、插入和删除

文章目录 1.概述2. 查找2.1 查找&#xff1a;算法2.2 查找&#xff1a;理解2.3 查找&#xff1a;实现2.4 查找&#xff1a;语义 3. 插入3.1 插入&#xff1a;算法3.2 插入&#xff1a;实现 4. 删除4.1 删除&#xff1a;框架4.2 删除&#xff1a;单分支4.3 删除&#xff1a;双分…

Pyqt QCustomPlot 简介、安装与实用代码示例(一)

目录 简介安装实用代码示例带有填充的简单衰减正弦函数及其红色的指数包络线具有数据点的 sinc 函数、相应的误差条和 2--sigma 置信带几种散点样式的演示展示 QCustomPlot 在设计绘图方面的多功能性 结语 所有文章除特别声明外&#xff0c;均采用 CC BY-NC-SA 4.0 许可协议。转…

RERCS系统开发实战案例-Part05 FPM Application的Feeder Class搜索组件的实施

1、通过事务码 SE24对Feeder Class实施 1&#xff09;接口页签的简单说明&#xff1a; ① IF_FPM_GUIBB&#xff1a;通用UI构建块&#xff0c;整个UIBB模块的基础接口&#xff1b; ② IF_FPM_GUIBB_SEARCH&#xff1a;通用搜索UI构建块&#xff0c;搜索组件UIBB的基础接口&…

期末复习GGG-----查找子串

郭的 char *search( char *s, char *t ){int i0;while(s[i]){int j0;if(s[i]t[0]){while(s[ij]t[j]&&t[j]){j;}if(t[j]\0)return si;}i;}return NULL; } AI的 #include <stdio.h> #include <string.h> #define MAXS 30char *search(char *s, char *t);in…

React项目-Cesium地图初始化

一、环境描述 React集成Cesium地图需要注意软件兼容性问题&#xff0c;可以从官网或者百度文章查询React和Cesium地图的版本兼容性&#xff0c; 1、软件版本 &#xff08;1&#xff09;create-react-app创建项目&#xff1b; &#xff08;2&#xff09;React版本&#xff1a;1…

ctfshow web七夕杯

web签到 执行命令没有回显&#xff0c;我们直接写文件就可以了 有字符长度限制 ls />a nl /*>a访问url/api/a下载文件 easy_calc <?phpif(check($code)){eval($result."$code".";");echo($result); }function check(&$code){$num1…

Golang | Leetcode Golang题解之第164题最大间距

题目&#xff1a; 题解&#xff1a; type pair struct{ min, max int }func maximumGap(nums []int) (ans int) {n : len(nums)if n < 2 {return}minVal : min(nums...)maxVal : max(nums...)d : max(1, (maxVal-minVal)/(n-1))bucketSize : (maxVal-minVal)/d 1// 存储 (…

aasist-bladedisc 音频反欺骗算法模型

AASIST 论文 参考ASIST: Audio Anti-Spoofing using Integrated Spectro-Temporal Graph Attention Networks https://arxiv.org/pdf/2110.01200.pdf 模型结构 aasist是一种开源的音频反欺诈的模型&#xff0c;主要的模型结构如下所示&#xff1a; 算法原理 环境配置 Dock…

git配置1-不同的项目使用不同用户名或邮箱

1. 全局用户名和邮箱 1.1. 设置1.2. 存储1.3. 查看 2. 针对指定项目单独设置 2.1. 设置2.2. 存储2.3. 查看 1. 全局用户名和邮箱 1.1. 设置 git config --global user.name 张三 git config --global user.email zhangsanexample.com1.2. 存储 git的全局配置一般会存在hom…

Hi3861 OpenHarmony嵌入式应用入门--总引导连接

这篇没有内容&#xff0c;只是根据内容先后顺序进行连接汇总。 Hi3861 OpenHarmony嵌入式应用入门--鸿蒙开发环境搭建_hi3861开发环境-CSDN博客 Hi3861 OpenHarmony嵌入式应用入门--基于HI-12F开发板烧写程序-CSDN博客 Hi3861 OpenHarmony嵌入式应用入门--启动流程-CSDN博客…

CVE-2023-38836(文件上传+命令执行)

简介 BoidCMS v.2.0.0 存在文件上传漏洞&#xff0c;远程攻击者可通过添加 GIF 头部绕过 MIME 类型检查&#xff0c;执行任意代码。 过程 打开靶场 对网站进行目录扫描 发现后台&#xff0c;登录弱口令账号密码 admin/password 发现文件上传位置 根据简介提示&#xff0c;…

CentOS 7.9检测硬盘坏区、实物定位(三)

系列文章目录 CentOS 7.9上创建JBOD&#xff08;一&#xff09; CentOS 7.9上创建的JBOD阵列恢复&#xff08;二&#xff09; 文章目录 系列文章目录前言一、在系统中找到硬盘对应的盘符二、使用命令定位实物1.badblocks检测坏块2.对2T以上的硬盘检测&#xff08;对本篇非必要…

我用chatgpt写了一款程序

众所周知&#xff0c;Chatgpt能够帮助人们写代码&#xff0c;前几天苏音试着完全用Chatgpt写一款Python程序 有一句话我很赞同&#xff0c;未来能代替人的不是AI&#xff0c;是会使用AI的人。 最终&#xff0c;写下来效果还不错&#xff0c;完全提升了我的办公效率。 开发前…

Linux Centos7.5 开放指定端口

在Linux中开放特定端口通常涉及配置防火墙规则或网络访问控制。以下是基本步骤&#xff1a; 使用firewalld开放端口 如果你的系统使用firewalld作为防火墙管理工具&#xff0c;可以按照以下步骤操作&#xff1a; 检查当前firewalld状态&#xff1a; sudo firewall-cmd --stat…

PCI 电源管理和设备驱动程序方案

方案 1&#xff1a;关闭设备 1.设备驱动程序&#xff1a;保存专有设备状态。 2.PCI 驱动程序&#xff1a;保存即插即用配置&#xff0c;禁用设备 (中断和 BAR) &#xff0c;并使用 PCI-PM 寄存器将设备置于 D3 中。 3.ACPI 驱动程序&#xff1a;运行 ASL 代码 (_PS3 和 _OFF&a…

0X0-基于Sklearn的机器学习入门:聚类(上)

本节及后续章节将介绍深度学习中的几种聚类算法&#xff0c;所选方法都在Sklearn库中聚类模块有具体实现。本节为上篇&#xff0c;将介绍几种相对基础的聚类算法&#xff0c;包括K-均值算法和均值漂移算法。 目录 X.1 聚类概述 X.1.1 聚类的种类 X.1.2 Sklearn聚类子模块 …

设计模式1

1、面向对象三大特性&#xff1a;封装、继承、多态 2、什么是接口&#xff1f; 3、面向对象的SOLID五大原则 4、简单工厂模式 5、工厂方法模式

网络安全:数据库安全性

文章目录 网络安全&#xff1a;数据库安全性引言数据库安全性的重要性常见的数据库安全威胁数据库安全性的最佳实践数据加密访问控制审计和监控 结语 网络安全&#xff1a;数据库安全性 引言 在前两篇文章中&#xff0c;我们讨论了SQL注入的概念和防范措施。本篇文章将聚焦于…

Python数据分析与建模库-03数据分析处理库Pandas-1.数据读取

该视频主要讲述了pandas库在数据处理中的重要性。 首先介绍了pandas库是基于numpy库封装了一些操作&#xff0c;简化了数据处理过程。然后通过读取CSV文件的例子&#xff0c;演示了如何使用pandas的read_csv函数将数据读入&#xff0c;并展示了数据类型和数据格式。 接着介绍…