技术标签: Swagger3 java SpringFox Spring OpenAPI3 SpringDoc
在学习使用spring集成swagger3时查阅文档发现
SpringFox未支持 OpenAPI3 标准,而是还在支持2017年就已经停止维护的OpenAPI2了
而搜遍全网写OpenAPI3的教程少的可怜
但还是找到了与之相关的文章
文章跳转
但没有关于权限验证的相关教程,答案还得去官网找
官网链接
添加OpenAPI类型的bean
前四步都是官网上代码的,没有什么难度,所以不贴代码
上面的配置可以直接写在启动类里面
也可以创建一个配置类专门写关于swagger的配置
这里我用第二种
配置完这四步后
还需要在application.yml配置文件里做一些关于springDoc的配置
springdoc:
swagger-ui:
path: /swagger-ui.html #swagger-ui访问路径 http://ip:端口/swagger-ui.html 默认就是swagger-ui.html
csrf:
enabled: true # 启用CSRF支持
packages-to-scan: com.xiaohong.user.controller #包扫描路径
启动服务,访问网址
http://localhost:18081/swagger-ui.html (按自己的配置写)
界面大概就这样
如果访问后台接口不需要权限认证
那到这里就可以了
如果需要权限认证
那继续往后配
我这里的后台接口访问都需要携带token请求头才允许访问
所以我选择使用一个全局安全认证
在官方文档里有这样一段相关的描述
试着把之前定义的OpenAPI修改
@Bean
public OpenAPI springShopOpenAPI() {
return new OpenAPI()
.components(new Components()
.addSecuritySchemes("basicScheme", new SecurityScheme()
.type(SecurityScheme.Type.HTTP).scheme("basic")))
.info(new Info().title("用户微服务")
.description("用户微服务接口文档")
.version("v0.0.1")
.license(new License().name("name").url("http://www.baidu.com")))
.externalDocs(new ExternalDocumentation()
.description("SpringShop Wiki Documentation")
.url("https://springshop.wiki.github.org/docs"));
}
重启服务
可以发现多了一个Authorize按钮
点开发现需要输入用户名和密码
这不是我想要的认证方式
我想要的是输入一段token
然后每次请求都把这段token 放到请求头中访问后台资源
那如何在请求头里添加参数呢?再次查看官方文档
找到相关的回答
点开链接看看
链接
可以看到这里有多种认证模式
刚刚使用的只是其中的HTTP模式
而根据文档
适合我的是API keys模式
那什么是API keys模式呢?点进去看一下
可以看到这种认证模式可以将token数据在请求时放到请求参数/请求头/cookie中
那怎么配置呢?继续往下看
这里给了一段示例代码
这不是Java格式,应该是json格式
仔细看还是能发现和之前的Java代码有关系的
可以看出这里应该是能够对应上的
好在我又找到了一条文章链接介绍了相关字段的意义
添加链接描述
那接下来就能够配置了
@Bean
public OpenAPI springShopOpenAPI() {
return new OpenAPI()
.components(new Components().addSecuritySchemes("Authorization", // key值
new SecurityScheme()
.type(SecurityScheme.Type.APIKEY) //请求认证类型
.name("Authorization") //API key参数名
.description("token令牌") //API key描述
.in(SecurityScheme.In.HEADER))) //设置API key的存放位置
.info(new Info().title("用户微服务")
.description("用户微服务接口文档")
.version("v0.0.1")
.license(new License().name("name").url("http://www.baidu.com")))
.externalDocs(new ExternalDocumentation()
.description("SpringShop Wiki Documentation")
.url("https://springshop.wiki.github.org/docs"));
}
重启试试
感觉没问题
随便输入一个value试试,看看发送的请求里是否携带了请求头
没找到期待的请求头
那。。。继续看文档
发现我忽略了一小段配置
文档页写明了
仅配置securitySchemes是不够的,还需要使用security才能生效!!
那就添加一个security试试
发现需要一个参数
看源码
直接new一个试试
发现是接口。。
那就自己创一个!!
看不懂就全靠猜!!
再把list加进去
重启试试
幸福来得太突然哈哈哈
附上完整OpenAPI
@Bean
public OpenAPI springShopOpenAPI() {
SecurityRequirement securityRequirement = new SecurityRequirement().addList("Authorization"); // 名字和创建的SecuritySchemes一致
List<SecurityRequirement> list = new ArrayList<>();
list.add(securityRequirement);
return new OpenAPI()
.components(new Components().addSecuritySchemes("Authorization", // key值
new SecurityScheme()
.type(SecurityScheme.Type.APIKEY) //请求认证类型
.name("Authorization") //API key参数名
.description("token令牌") //API key描述
.in(SecurityScheme.In.HEADER))) //设置API key的存放位置
.security(list)
.info(new Info().title("用户微服务")
.description("用户微服务接口文档")
.version("v0.0.1")
.license(new License().name("name").url("http://www.baidu.com")))
.externalDocs(new ExternalDocumentation()
.description("SpringShop Wiki Documentation")
.url("https://springshop.wiki.github.org/docs"));
}
这里请求头里没有传入数据是因为在api上少量一个配置
这里的name就是这里的key值
每个接口上的name值可以不一样,只要在配置文件里配置了即可
更全内容看
这里
文章浏览阅读145次。10.21终面已参加,希望能顺利通过终面拿到offer~一共三轮,电话面试+笔试+视频面试,视频面试3V110月19日投的新媒体运营的简历,HR说因为是周末,等工作日再联系我,在周一下午三点我接到了电话成功通过简历筛选和电话面试,整个电话面试的过程长,大概10分钟左右,因为前期稍微做了一些准备,所以还算对答如流,整个过程顺利,HR现场告诉我通过面试,并随即给我发了笔试题,让我准备一下,最晚三天之..._网易 python游戏服务器
文章浏览阅读6.5k次,点赞12次,收藏38次。MVC层次划分简述写在前面的一段话:首先要知道MVC和三层架构之间有什么关系:MVC:【 Model(数据模型) - View(视图) - Controller(控制器) 】三层架构:【 Presentation tier(展现层) - Application tier(应用层)+Date tier(数据访问层) 】很多人都有一个误解,认为Spring MVC的M、V、C对..._mvc分层
文章浏览阅读2.9k次。实践flink数据集sink到cassandra3_flink cassandra
文章浏览阅读7.1k次,点赞4次,收藏12次。文章目录一、前言二、codimd是什么?2.1 源于hackmd的超好用markdown编辑器2.2 codimd的作用三、安装和使用3.1 安装前需要知道的3.2 安装步骤3.2.1 创建数据库3.2.2 安装git3.2.3 安装docker3.2.4 安装docker compose3.2.5 安装codimd3.2.6 检查是否安装成功3.2.7 放行端口3.2.8 测试使用3.3 开始写..._群晖 docker 搭建 codimd
文章浏览阅读335次。Json json 可以定义多种类型 var jsonObj = { "key1":123, "key2":"name", "key3":[12,"age",true], //数组 "key4":false, "key5":{ //存一个json对象 "key6":456, "key7":"number" }} json其实就是一个Object对象, 他的key值 可以看成对象的一个属性, 获取他的value值...
文章浏览阅读87次。选题背景:超市账单管理系统是一种针对超市行业的管理工具,旨在提供高效、准确、便捷的账单管理服务。随着城市化进程的加快和人们生活水平的提高,超市作为日常生活必需品的主要供应渠道之一,扮演着重要的角色。然而,传统的超市账单管理方式存在一些问题,如手工记录容易出错、数据整理繁琐、信息不透明等。因此,开发一个科技化的超市账单管理系统成为了必要之举。选题意义:首先,超市账单管理系统的开发可以提高账单管理的效率。传统的超市账单管理方式通常需要员工手动记录商品销售信息,并进行数据整理和汇总。这种方式容易出现人为错
文章浏览阅读1.7k次。书签栏通讯 s7-1200与s7-200smart通讯-工业支持中心-西门子中国IO_deviceS7-1200PROFINET通信ET 200SP 安装视频 - ID: 95886218 - Industry Support Siemens云平台接入在线文档 - 低代码开发嵌入式设备 | 物一世 WareExpress在linux下使用c语言实现MQTT通信(一.MQTT原理介绍及流程图)_qq_44041062的博客-程序员宅基地C mqtt_百度搜索开发快M_拾度智能科技 att7022eu
文章浏览阅读1.6k次。职称英语全称为全国专业技术人员职称英语等级考试,是由国家人事部组织实施的一项国家级外语考试。1.概述全国专业技术人员职称英语等级考试是由人力资源和社会保障部组织实施的一项外语考试,它根据英语在不同专业领域活动中的应用特点,结合专业技术人员掌握和应用英语的实际情况,对申报不同级别职称的专业技术人员的英语水平提出了不同的要求。该考试根据专业技术人员使用英语的实际情况,把考试的重点放在了阅读理解上面。全..._全国专业技术人员职称英语等级考试 北京 取消
文章浏览阅读42次。恋爱指导篇 知心的小爱“真爱”是一个永不过时的话题,古代的人找对象,靠的是媒妁之言,父母定婚姻。现代的人靠的是相亲,自由恋爱,按理找一个喜欢的人结婚会很幸福,近几年反而离率更高了。古代人认识的人少,交流工具少,最多信鸽传书,信物传情。现代要认识一个人很容易了,最初是电话信息联系。前几年是qq,微信摇一摇,近两年是抖音,快手随便找一找。虽然找对象,寻伴侣更方便了,为何大部分人还是感觉更迷茫,不快乐...
文章浏览阅读109次。【代码】刷题记录第八十天-修剪二叉搜索树。
文章浏览阅读248次。关于 dcm4che WADO WADO:Web Access to DICOM Objects dcm4che 是一个为医疗保健企业的开源应用程序和工具集合。这些应用程序已经开发了Java编程语言的性能和便携性,在JDK 1.6及更高版本支持部署。在dcm4che项目的核心是一个强大的执行DICOM标准的。该dcm4che-1.x和dcm4che-2.X DICOM Tool..._dcm4che实现wado服务
文章浏览阅读2.2k次。zookeeper服务器会产生三类日志:事务日志、快照日志和log4j日志。在zookeeper默认配置文件zoo.cfg(可以修改文件名)中有一个配置项dataDir,该配置项用于配置zookeeper快照日志和事务日志的存储地址。在官方提供的默认参考配置文件zoo_sample.cfg中,只有dataDir配置项。其实在实际应用中,还可以为事务日志专门配置存储地址,配置项名称为dataLogD..._linux查看zookeeper日志