springboot集成springdoc-openapi(模拟前端请求)

目录

描述---痛点

Springfox对比springdoc-openapi

1. 成熟度和维护性：

2. 依赖和配置：

3. 注解和使用方式：

4. 特性和扩展性：

应用目录结构

pom文件

新增测试controller

StaffController

YUserController

启动测试看下

验证swagger

yml中添加配置

配置OpenApiConfig 

验证配置swagger

验证接口

无参

有参

优化下界面openapi

添加jar包

 验证结果

描述---痛点

我们项目中很多时候都会用到swagger swagger2 (以下全部称swagger)
当我们配置Springboot集成swagger时，要选对应的版本才可以，不然就会报各种错误，版本不匹配，或高或低
例如
Application run failed

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

java.lang.IllegalStateException: Cannot set parent bean factory to self

等等。就会很麻烦

或者是当我们去升级spring-boot的时候  也会遇到这些问题，这时我们可以尝试更改用springdoc-openapi-ui取替代swagger

springdoc-openapi-ui中间已经包含了swagger也就是说，使用springdoc-openapi-ui是可以替代的。他的配置相对的话就比较简单

配置起来也不会很麻烦，我们看下是如何配置

Springfox对比springdoc-openapi

在该片中我用的是springdoc-openapi，相对来说更加适合于我，简单轻量，配置更少一些，还有一点就是直接更喜欢

Springfox和springdoc-openapi都是用于在Spring Boot应用程序中集成OpenAPI和Swagger UI的库。

1. 成熟度和维护性：

- Springfox是一个相对成熟和广泛使用的库，已经存在一段时间，并且有一个活跃的社区进行维护和更新。

- springdoc-openapi是相对较新的库，但也在不断发展和更新，它的目标是提供更简单、更轻量级的集成方式。

2. 依赖和配置：

- Springfox通常需要引入`springfox-boot-starter`等相关依赖，并进行一些配置，以便生成和展示Swagger文档。

- springdoc-openapi通常只需要引入`springdoc-openapi-ui`依赖，并且不需要太多的配置即可生成和展示OpenAPI文档。

3. 注解和使用方式：

- Springfox使用`@Api`、`@ApiOperation`等注解来定义API文档，并提供了一些配置选项来自定义文档生成。

- springdoc-openapi使用`@io.swagger.v3.oas.annotations`包下的注解来定义API文档，它遵循OpenAPI规范，并提供了一些额外的注解来进行更细粒度的控制。

4. 特性和扩展性：

- Springfox提供了一些额外的特性和扩展，如支持Spring Security集成、自定义UI主题等。

- springdoc-openapi也提供了一些特性和扩展，如支持Spring Security集成、自定义UI主题等，但可能相对较少。

如何选择使用Springfox还是springdoc-openapi

如果你需要更成熟、功能更丰富的库，并且对配置和注解的灵活性有更高的要求，那么Springfox可能是一个不错的选择。

如果你更倾向于简单、轻量级的集成方式，并且遵循OpenAPI规范的优先级更高，那么springdoc-openapi可能更适合你。

应用目录结构

pom文件

我用的springboot是2.7.10还是比较新的。

只需要引入springdoc-openapi-ui这一个即可

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.10</version><relativePath/> <!-- lookup parent from repository --></parent><!--Springfox/swagger迁移springdoc-openapi & springdoc-openapi最新版本和springboot应用集成--><dependency><groupId>org.springdoc</groupId><artifactId>springdoc-openapi-ui</artifactId><version>1.5.12</version></dependency>
<!-- 可以不引入 --><dependency><groupId>org.reflections</groupId><artifactId>reflections</artifactId><version>0.9.12</version></dependency>
新增测试controller

`@Tag`注解用于指定相关测试controller的API

StaffController
package com.yun.greedy.modules.staff.controller;import com.yun.greedy.modules.staff.entity.Staff;
import com.yun.greedy.modules.staff.service.StaffService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.List;/*** <p>* 前端控制器* </p>** @author ex_yangqiusheng* @since 2023-06-29*/
@Slf4j
@RestController
@Tag(name = "StaffController测试数据", description = "测试数据验证")
@RequestMapping("/staff")
public class StaffController {@Autowiredprivate StaffService staffService;@GetMapping("/list")public List<Staff> list() {List<Staff> list = staffService.getBaseMapper().selectList(null);log.info("结果值打印--------------------");list.forEach(System.out::println);return list;}}
YUserController
package com.yun.greedy.modules.yuser.controller;import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.yun.greedy.modules.yuser.entity.YUser;
import com.yun.greedy.modules.yuser.service.YUserService;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.configurationprocessor.json.JSONException;
import org.springframework.boot.configurationprocessor.json.JSONObject;
import org.springframework.web.bind.annotation.*;import java.util.List;@Tag(name = "YUserController账户操作", description = "账户相关信息")
@RequestMapping("/YUser")
@RestController
public class YUserController {@Autowiredprivate YUserService yUserService;@GetMapping(value = "/queryYUserById")public YUser queryYUserId(Long yId){YUser yUser = yUserService.getById(yId);return yUser;}@GetMapping(value = "/queryYUserByName")public List<YUser> queryYUserName(String name){List<YUser> list = yUserService.getBaseMapper().selectList(new QueryWrapper<YUser>().eq("y_name", name));return list;}@GetMapping(value = "/searchYUser")public YUser searchYUser(Long yId,String yName){YUser yUser = YUser.builder().yId(yId).yName(yName).build();return yUser;}@PostMapping(value = "/postYUser")public YUser queryYUser(@RequestBody JSONObject jsonObject) throws JSONException {long yId = jsonObject.getLong("yId");String yName = jsonObject.getString("yName");YUser yUser = YUser.builder().yId(yId).yName(yName).build();return yUser;}
}
启动测试看下

启动完成，如果不知道如何搭建新项目的，可以借鉴看下这篇文章，从零到一新建项目

https://blog.csdn.net/weixin_59383491/article/details/132596733

验证swagger

http://localhost:8088/swagger-ui/index.html

浏览器输入这个地址，显示这个页面说明swagger正常。

yml中添加配置
springdoc:api-docs:#是否开启文档功能，默认为true，可不配置enabled: trueswagger-ui:# 访问ip:host/api，可直接访问Swagger springdocpath: /api
配置OpenApiConfig 
package com.yun.greedy.config;import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.tags.Tag;
import org.reflections.Reflections;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.util.ConfigurationBuilder;
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;import java.util.Set;/*** 这里的@OpenAPIDefinition 和@SecurityScheme都是springdoc注解，主要声明API信息：标题、版本、许可证、安全性、服务器、标签、安全性和拓展文档信息。* 配置jwt时，@SecurityScheme(type = SecuritySchemeType.HTTP, name = “JWT”, scheme = “bearer”, in = SecuritySchemeIn.HEADER).scheme 还支持basic。* 具体可查看官网文档: https://springdoc.org/index.html*/
@OpenAPIDefinition(security = @SecurityRequirement(name = "Authorization"))
@SecurityScheme(type = SecuritySchemeType.APIKEY, name = "Authorization", scheme = "Authorization", in = SecuritySchemeIn.HEADER)
@Configuration
public class OpenApiConfig {private String title = "寒舞";//标题private String group = "group";//分组名称private String description = "被你捧做神明的人，怎会低头看尘埃里的你";//简介private String version = "ver_1.0.0";//版本private String termsOfService = "https://blog.csdn.net/weixin_59383491";//服务Urlprivate String contactName = "一百减一是零";//作者@Beanpublic OpenAPI springOpenAPI() {return new OpenAPI().info(getInfo());}public Info getInfo() {return new Info().title(title).description(description).version(version).termsOfService(termsOfService).license(buildLicense()).contact(buildContact());}public Contact buildContact() {return new Contact().name(contactName).email("517306474@qq.com")//Your API Contact Email.url("https://blog.csdn.net/weixin_59383491");//Your API Contact URL}public License buildLicense() {return new License().name("APACHE LICENSE, VERSION 2.0")//许可证.url("https://www.apache.org/licenses/LICENSE-2.0.html");}@Beanpublic GroupedOpenApi publicApi() {return GroupedOpenApi.builder().group(group).pathsToMatch("/YUser/**","/staff/**")//API路径，不是类路径//这里是添加对应标签/*.addOpenApiCustomiser(openApi -> {Tag staffTag = new Tag();staffTag.setName("myController");//标签名称staffTag.setDescription("验证一下所有Controller");//描述// 指定某个包中的所有controllerString packagePath = "com.yun.greedy.modules.staff.controller";Set<Class<?>> controllerClasses = getControllerClasses(packagePath);for (Class<?> controllerClass : controllerClasses) {String controllerName = controllerClass.getSimpleName();staffTag.addExtension("x-controller-" + controllerName, controllerClass.getName());}// 指定单独的controller
//                    String controllerName = "YourControllerName";
//                    Class<?> controllerClass = getControllerClass(packagePath, controllerName);
//                    if (controllerClass != null) {
//                        staffTag.addExtension("x-controller-" + controllerName, controllerClass.getName());
//                    }if (null != openApi.getTags()){openApi.getTags().add(staffTag);} else {openApi.addTagsItem(staffTag);//添加标签}})*/.build();}//显式地配置扫描器private Reflections reflectionsConf(String packagePath){return new Reflections(new ConfigurationBuilder().forPackages(packagePath).addScanners(new SubTypesScanner()));}// 获取某个包中的所有controller类private Set<Class<?>> getControllerClasses(String packagePath) {Reflections reflections = reflectionsConf(packagePath);return reflections.getTypesAnnotatedWith(RestController.class);}// 获取单独的controller类private Class<?> getControllerClass(String packagePath, String controllerName) {Reflections reflections = reflectionsConf(packagePath);Set<Class<?>> controllerClasses = reflections.getTypesAnnotatedWith(RestController.class);for (Class<?> controllerClass : controllerClasses) {if (controllerClass.getSimpleName().equals(controllerName)) {return controllerClass;}}return null;}}
验证配置swagger

http://localhost:8088/api

重启应用，输入此地址，展示以下页面显示配置成功！

验证接口
无参

try一下

执行结果

有参

执行结果

现在看起来是没有问题的，配置，展示，执行结果都是正常，但是这个页面看着削为有点简陋

优化下界面openapi
添加jar包
<!--美化swagger--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-springdoc-ui</artifactId><version>3.0.3</version></dependency>

  http://localhost:8088/doc.html

重启应用，输入地址，展示以下界面就可以了。

 验证结果

OK执行成功，到此就算是完成了

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

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

相关文章

亚马逊品牌分析ABA功能有哪些？亚马逊选品的量化标准有哪些？——站斧浏览器

亚马逊品牌分析ABA功能有哪些？亚马逊选品的量化标准有哪些？——站斧浏览器

亚马逊品牌分析ABA功能有哪些&#xff1f; 1、品牌市场份额&#xff08;Share of Voice&#xff09; ABA提供了品牌在特定类别中市场份额的详细数据。这一模块帮助品牌所有者准确评估其品牌在整个市场中的竞争地位和表现。通过了解市场份额&#xff0c;品牌方可以制定更具针对…
阅读更多...
Guava的TypeToken在泛型编程中的应用

Guava的TypeToken在泛型编程中的应用

第1章&#xff1a;引言 在Java世界里&#xff0c;泛型是个相当棒的概念&#xff0c;能让代码更加灵活和类型安全。但是&#xff0c;泛型也带来了一些挑战&#xff0c;特别是当涉及到类型擦除时。这就是TypeToken大显身手的时候&#xff01; 作为Java程序员的咱们&#xff0c;…
阅读更多...
Epson爱普生手臂机器人与PC通讯 C#

Epson爱普生手臂机器人与PC通讯 C#

一、Epson手臂配置 1.安装Epson手臂控制软件 安装Epson手臂控制软体EPSON RC+ 7.0（根据实际需求下载应用），可以去官网下载安装。 2.硬件配置 准备一台PC，用网线连接PC和EPSON手臂控制器。 3.在PC上修改IP地址 EPSON手臂默认IP（192.168.0.1），PC IP改为手臂同一网段…
阅读更多...
MFC使用高速绘图控件high-speed Charting Control绘制柱形图

MFC使用高速绘图控件high-speed Charting Control绘制柱形图

1. 创建MFC单文档工程BarChartDemo。 2. 在工程文件夹下新建文件夹ChartCtrl，将ChartCtrl源码放入，如下图所示。在工程中添加这些项，项目——添加——现有项，全部添加。 3. 添加一个对话框，ID为IDD_DLG_BAR，类名为CBarDlg。 4. 在对话框中添加Custom Control控件，将控…
阅读更多...
业务框架概念及极简史

业务框架概念及极简史

概念 ● 我们通过在“什么是业务”章节对业务的概念有个较为明确的认知&#xff0c;业务就是企业的经营活动。架构&#xff0c;也是等同于企业架构中的架构概念&#xff0c;架构就是 输出某种价值的主题&#xff0c;里面的配置&#xff1a;各种元素&#xff0c;元素之间的关系…
阅读更多...
一个简单的获取显示器长宽和显示器分辨的代码

一个简单的获取显示器长宽和显示器分辨的代码

最近在做大屏显示&#xff0c;在现显示的时候有些显示器是不规则的&#xff0c;投到大屏上显示效果不好&#xff0c;可以直接获取显示器的分辨率&#xff0c;本地调整好&#xff0c;再直接部署。 <!DOCTYPE html> <html lang"en"> <head><meta …
阅读更多...
LT8711UX,LT8711UXC ,LT8711UXD ,LT8711UXE1,LT8711UXE2的区别，选型的工程师注意了！！！

LT8711UX,LT8711UXC ,LT8711UXD ,LT8711UXE1,LT8711UXE2的区别，选型的工程师注意了！！！

LT8711UX,LT8711UXC ,LT8711UXD ,LT8711UXE1,LT8711UXE2做为龙迅的重点物料&#xff0c;大家都不陌生。 可是它们不一样的后缀&#xff0c;又有什么不一样的应用区别呢&#xff1f; LT8711***均为DP/Type-C to HDMI系列的芯片。 LT8711UX&#xff0c;是一款带音频的Type-C…
阅读更多...
Midjourney V6版本的5大新特性，掌握了，想法和实现信手拈来

Midjourney V6版本的5大新特性，掌握了，想法和实现信手拈来

Midjourney v6已推出&#xff1a;更简单的提示、增强的文本集成和更高水平的照片真实感&#xff01;以下是每个创意人员都需要了解的 5 个重要见解。 一、产品文字整合 使用简单风格提示向您的产品添加文本提示&#xff1a;带有文字“SALMA”的白色健身瓶 Midjourney v5.2&am…
阅读更多...
HarmonyOS 点击物理返回键再按一次退出系统（eTS）

HarmonyOS 点击物理返回键再按一次退出系统（eTS）

&#xff08;1&#xff09;首先&#xff0c;定义一个变量&#xff0c;用于计算用户两次按下返回键的时间差&#xff1a; //todo 定义全局变量State exitTime: number 0;&#xff08;2&#xff09;然后就是一个捕捉用户按下返回键的事件&#xff1a; //todo 定义全局变量State …
阅读更多...
【Vulnhub 靶场】【DarkHole: 1】【简单】【20210730】

【Vulnhub 靶场】【DarkHole: 1】【简单】【20210730】

1、环境介绍 靶场介绍&#xff1a;https://www.vulnhub.com/entry/darkhole-1,724/ 靶场下载&#xff1a;https://download.vulnhub.com/darkhole/DarkHole.zip 靶场难度&#xff1a;简单 发布日期&#xff1a;2021年07月18日 文件大小&#xff1a;2.9 GB 靶场作者&#xff1a…
阅读更多...
PHP下载安装以及基本配置

PHP下载安装以及基本配置

目录 引言 官网 下载 配置 1. 鼠标右键“此电脑”>“属性” 2. 打开高级系统设置 3. 打开环境变量 4. 双击系统变量中的path 5. 新建新的path 6. 将刚刚安装的位置加入环境变量 7. 检查是否安装成功 引言 PHP&#xff08;"PHP: Hypertext Preprocessor"…
阅读更多...
Unity DOTS物理引擎的核心分析与详解

Unity DOTS物理引擎的核心分析与详解

最近DOTS发布了正式的版本,同时基于DOTS的理念实现了一套高性能的物理引擎&#xff0c;今天我们来给大家分享和介绍一下这个物理引擎的使用。 Unity.Physics的设计哲学 Unity.Physics是基于DOTS设计思想的一个高性能C#物理引擎的实现, 包含了物理刚体的迭代计算与碰撞检测等查…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023