SpringBoot基于OpenAPI3的接口文档管理快速集成和使用

你好,这里是codetrend专栏“SpringCloud2023实战”。

本文主要简单介绍SpringCloud2023中进行接口文档管理,方便前后端开发和文档维护。文档管理工具基于开源的knife4j封装的openapi3。

前言

OpenAPI 3.0(前身为Swagger)是一种RESTful API文档规范。OpenAPI 3.0规范是一种易于阅读和理解、跨平台和语言、提高协作效率、提供API管理和监控的RESTful API文档规范,提高了API设计和开发的效率、可重用性和互操作性。

有以下几个优点:

  • 易于阅读和理解:OpenAPI 3.0使用简单的YAML或JSON格式,描述了API的所有细节,包括资源路径、HTTP方法、请求参数和响应模型等内容。由于其清晰、结构化的语法,开发人员可以很容易地阅读和理解API文档,快速上手使用API。
  • 自动化工具支持:OpenAPI 3.0规范被广泛支持和使用,有许多自动化工具可以基于OpenAPI规范生成客户端代码、测试用例、API文档和Mock数据等。这些工具能够大大提高开发效率,降低开发成本。
  • 跨平台和语言:OpenAPI 3.0是一种独立于编程语言和平台的规范,可以应用于Java、PHP、Python、Node.js等各种语言和环境中。由于标准化的规范,不同团队或公司之间可以更加容易地进行API的交互和集成,提高了系统的可复用性和互操作性。
  • 提高协作效率:OpenAPI 3.0定义了API的标准接口和参数,避免了开发人员之间因理解不一致而产生的差异。它也为项目经理、测试人员和文档编写者等其他团队提供了清晰的API文档,让他们更快地了解API功能和接口规范,提高协作效率。
  • 提供API管理和监控:OpenAPI 3.0支持API管理和监控的自动化工具集成,例如Swagger UI和Swagger Editor等工具,这些工具可以对API进行实时监控和可视化展示,并提供了许多有用的功能,如在线修改API定义、Mock数据生成和API调试等。

OpenAPI3集成

引入pom.xml

  • 引入OpenAPI主要是引入 springdoc-openapi-starter-webmvc-ui
  • 这里使用 knife4j-openapi3-jakarta-spring-boot-starter 快速集成到springboot 3项目,以及使用它提供的增强服务。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><dependencies><!--其他省略--><!-- 引入openapi3接口文档支持 --><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId></dependency></dependencies></project>

修改配置

  • 新增配置文件 application.yml,配置主要是 springdoc 下面的配置,以及 knife4j 下面的增强实现配置。
spring.application.name: client1
# springdoc-openapi项目配置
springdoc:swagger-ui:path: /swagger-ui.htmltags-sorter: alphaoperations-sorter: alphaapi-docs:path: /v3/api-docsgroup-configs:- group: 'default'paths-to-match: '/**'packages-to-scan: io.rainforest.banana.client1.web
# knife4j的增强配置,不需要增强可以不配
knife4j:enable: truesetting:language: zh_cnbasic:enable: true# Basic认证用户名username: yulin# Basic认证密码password: 123yl.

修改启动类

  • 启动类不需要特殊修改。文档的开启和关闭基于 knife4j.enable控制的。
package io.rainforest.banana.client1;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

接口demo

  • 通过访问 http://localhost:10101/client1/swagger-ui.html ,输入账号密码 yulin/123yl. 就可以访问到最新的接口文档。
package io.rainforest.banana.client1.web.demo;import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;@RestController
@RequestMapping("body")
@Tag(name = "body参数")
public class BodyController {@Operation(summary = "普通body请求")@PostMapping("/body")public ResponseEntity<String> body(String fileResp){return ResponseEntity.ok(fileResp);}@Operation(summary = "普通body请求+Param+Header+Path")@Parameters({@Parameter(name = "id",description = "文件id",in = ParameterIn.PATH),@Parameter(name = "token",description = "请求token",required = true,in = ParameterIn.HEADER),@Parameter(name = "name",description = "文件名称",required = true,in=ParameterIn.QUERY)})@PostMapping("/bodyParamHeaderPath/{id}")public ResponseEntity<String> bodyParamHeaderPath(@PathVariable("id") String id, @RequestHeader("token") String token, @RequestParam("name")String name, @RequestBody String fileResp){return ResponseEntity.ok(fileResp+""+",receiveName:"+name+",token:"+token+",pathID:"+id);}
}

具体的openapi3注释和文档可以查看官方文档。和swagger的语法结构类似,但是注解名称和属性都还是差异很大的。

以下是一个简单的Swagger2和OpenAPI3的注解映射关系,可以参考:

@Api → @Tag
@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")
@ApiParam → @Parameter
@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")

关于作者

来自一线全栈程序员nine的探索与实践,持续迭代中。

欢迎关注或者点个小红心~

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

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

相关文章

Linux_应用篇(11) 线程

上一章&#xff0c;学习了进程相关的知识内容&#xff0c; 对进程有了一个比较全面的认识和理解&#xff1b; 本章开始&#xff0c; 将学习 Linux应用编程中非常重要的编程技巧---线程&#xff08;Thread&#xff09; &#xff1b;与进程类似&#xff0c;线程是允许应用程序并发…

GaussDB数据库如何创建修改数据库和数据表

目录 一、背景 二、创建数据库和数据表 1. 创建数据库 2.创建数据表 三、修改表结构 1. 添加列 2. 修改列 3. 删除列 四、添加约束 1. 添加主键约束 2. 添加外键约束 3.添加唯一性约束 五、示例代码 -- 创建数据库 -- 使用新创建的数据库 -- 创建 department 表…

强化运维管理:多维度资源分组与全面监控

在当今高度信息化的时代&#xff0c;数据中心的运维管理显得尤为重要。为了确保各类资源能够高效、稳定地运行&#xff0c;一个强大的运维管理系统是必不可少的。本文将从资源分组管理、网络设备及链路监控、操作系统监控、数据库监控、虚拟化监控、安全监测以及业务系统监测等…

发送Http请求的两种方式

说明&#xff1a;在项目中&#xff0c;我们有时会需要调用第三方接口&#xff0c;获取调用结果&#xff0c;来实现自己的业务逻辑。调用第三方接口&#xff0c;通常是双方确定好&#xff0c;由对方开放一个接口&#xff0c;需要我们根据他们提供的接口文档&#xff0c;组装Http…

MySQL 使用方法以及教程

一、引言 MySQL是一个流行的开源关系型数据库管理系统&#xff08;RDBMS&#xff09;&#xff0c;广泛应用于Web开发、数据分析等领域。它提供了高效、稳定的数据存储和查询功能。同时&#xff0c;Python作为一种强大的编程语言&#xff0c;也提供了多种与MySQL交互的库&#…

Ubuntu 24.04 LTS 安装Docker

1 更新软件包索引&#xff1a; sudo apt-get update 2 安装必要的软件包&#xff0c;以允许apt通过HTTPS使用仓库&#xff1a; sudo apt-get install apt-transport-https ca-certificates curl software-properties-common 3 添加Docker的官方GPG密钥&#xff1a; curl -fs…

算法金 | 你真的完全理解 Logistic 回归算法了吗

大侠幸会&#xff0c;在下全网同名「算法金」 0 基础转 AI 上岸&#xff0c;多个算法赛 Top 「日更万日&#xff0c;让更多人享受智能乐趣」 今日 178/10000 1. 引言 吴恩达&#xff1a;机器学习的六个核心算法&#xff01;&#xff0c; 通透&#xff01;&#xff01;十大回…

Python专为开发和部署数据驱动的应用程序库之taipy使用详解

概要 Taipy 是一个强大的 Python 库,专为开发和部署数据驱动的应用程序而设计。它通过提供一套丰富的工具和组件,使开发者能够快速构建和维护复杂的业务逻辑和数据交互界面。无论是金融分析、供应链管理还是任何需要高度数据交互的应用,taipy 都能提供高效的解决方案。 安装…

Orange AIpro开箱上手

0.介绍 首先感谢官方给到机会&#xff0c;有幸参加这次活动。 OrangePi AIpro(8T)采用昇腾AI技术路线&#xff0c;具体为4核64位处理器AI处理器&#xff0c;集成图形处理器&#xff0c;支持8TOPS AI算力&#xff0c;拥有8GB/16GB LPDDR4X&#xff0c;可以外接32GB/64GB/128GB/2…

js常用的数组方法 js常用的字符串方法

数组方法: 1. reverse :将数组中元素的位置颠倒,并返回该数组。该方法会改变原数组; 2. sort : 用(原地算法)对数组的元素进行排序,并返回数组。 1. 第一个参数是要排序的数组或范围。 2. 第二个参数是排序依据,即按照数组中的第几行或第几列进行排序。 3. 第三…

小程序抓包详细教程

小程序抓包详细教程 前言&#xff1a;关于小程序抓包一直想写出一个比较详细的教程 实验设备&#xff1a; ​ 微信: https://windows.weixin.qq.com/?langzh_CN ​ Proxifier&#xff1a;https://www.proxifier.com/download/ (需要挂梯子访问下载) ​ burpsuite&#xff…

[每日一题]170:分糖果 II

文章目录 题目描述题解思路 题目描述 排排坐&#xff0c;分糖果。 我们买了一些糖果 candies&#xff0c;打算把它们分给排好队的 n num_people 个小朋友。 给第一个小朋友 1 颗糖果&#xff0c;第二个小朋友 2 颗&#xff0c;依此类推&#xff0c;直到给最后一个小朋友 n …

1.JAVA小项目(零钱通)

一、说明 博客内容&#xff1a;B站韩顺平老师的视频&#xff0c;以及代码的整理。此项目分为两个版本&#xff1a; 面向过程思路实现面向对象思路实现 韩老师视频地址&#xff1a;【【零基础 快速学Java】韩顺平 零基础30天学会Java】 https://www.bilibili.com/video/BV1fh4…

【Linux】GNU编译器基础-GDB

GDB调试&#xff1a;gdb调试的是可执行文件&#xff0c;在编译时加入-g &#xff0c;告诉编译器在编译时加入调试信息&#xff0c;这样gdb才能调试这个被编译的文件,同时使用-Wall显示所有的警告信息。 g -g test.cpp -o test.out -Wall GDB命令格式&#xff1a; 命令功能实例…

flink 事件处理 CEP 详解

简述 Apache Flink CEP&#xff08;Complex Event Processing&#xff0c;复杂事件处理&#xff09;是一个基于Flink Runtime构建的复杂事件处理库&#xff0c;它允许用户定义复杂的模式来检测和分析事件流中的复杂事件。 **复杂事件处理&#xff08;CEP&#xff09;&#xf…

Dinky FlinkSQL Doris读取写入

Dinky运行前开启全局变量&#xff0c;以支持使用&#xff1a; sink.sink.label-prefix ${idUtil.simpleUUID()} Mysql同步Doris - testMysqlCdcDoris&#xff1a; EXECUTE CDCSOURCE demo_doris WITH (connector mysql-cdc,hostname 172.xxx,port 3306,username xxx,pas…

gorm的find和scan使用

在 GORM 中&#xff0c;.Find() 和 .Scan() 都可以用于检索数据库记录&#xff0c;但它们之间存在一些差异&#xff0c;并不完全等同于彼此。 使用例子 Find 方法的使用例子 查找单一记录&#xff1a; var result models.MyModel db.Where(“id ?”, 1).Find(&result…

Spring 源码:深度解析AOP源码配置解析

文章目录 一、 解析AOP配置的入口1.1 从XML配置到AOP Namespace的解析流程1.2 分析注解驱动的AOP配置解析流程 二、AOP配置解析的核心流程2.1 ConfigBeanDefinitionParser 类2.2 parse()2.3 parseAdvisor()2.4 parseAspect()2.5 parsePointcut()2.6 createAdvisorBeanDefinitio…

算法每日一题(python,2024.05.29) day.11

题目来源&#xff08;力扣. - 力扣&#xff08;LeetCode&#xff09;&#xff0c;简单&#xff09; 解题思路&#xff1a; 法一&#xff1a;切片函数法 直接用python中的切片函数直接解决 法二&#xff1a;交换法 从俩头开始交换字符串的数字&#xff0c;若为奇数&#xff…

具有激情的技术管理者才是优秀的领导者

与其他类型的管理者相比&#xff0c;技术管理者更要具有激情&#xff0c;有激情的技术领导者才能影响和感染团队成员&#xff0c;实现团队的目标。 激情能够带领团队走出阴霾。在所有人都觉得没有希望而选择放弃的时候&#xff0c;有激情的管理者能够带领团队面对困难&#xf…