SpringDoc基础配置和集成OAuth2登录认证教程

本期内容

  1. 学会通过注解和Java代码的方式添加SpringDoc配置。
  2. 在swagger-ui提供的页面上提供OAuth2登录认证，在集成Security的情况下便捷获取access_token并在请求时按照OAuth2规范携带。

为什么集成OAuth2登录认证？

现在大部分教程是在swagger-ui页面添加一个请求头，使用时先去获取一个token，然后再将获取的token填充至页面的token输入框内，如果是通过某个接口自己生成token的方式使用这种配置没什么太大问题，但是如果是通过OAuth2登录获取token时就比较麻烦，要填充token type和access token，所以在swagger-ui提供的页面中提供OAuth2登录的入口，OAuth2登录自动配置，一步到位。

配置方式说明

SpringDoc提供了两种方式来添加配置：

  1. 注解
  2. Java类的方式

注解

注解配置类

配置方式如下代码所示，详细内容请看代码中的注释

package com.example.config;

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.info.Info;
import io.swagger.v3.oas.annotations.info.License;
import io.swagger.v3.oas.annotations.security.OAuthFlow;
import io.swagger.v3.oas.annotations.security.OAuthFlows;
import io.swagger.v3.oas.annotations.security.OAuthScope;
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.annotations.security.SecuritySchemes;
import org.springframework.context.annotation.Configuration;

/**
 * Spring Doc OpenApi 注解配置
 *
 * @author vains
 */
@Configuration
@OpenAPIDefinition(
        info = @Info(
                // 标题
                title = "${custom.info.title}",
                // 版本
                version = "${custom.info.version}",
                // 描述
                description = "${custom.info.description}",
                // 首页
                termsOfService = "${custom.info.termsOfService}",
                // license
                license = @License(
                        name = "${custom.license.name}",
                        // license 地址
                        url = "http://127.0.0.1:8080/example/test01"
                )
        ),
        // 这里的名字是引用下边 @SecurityScheme 注解中指定的名字，指定后发起请求时会在请求头中按照OAuth2的规范添加token
        security = @SecurityRequirement(name = "${custom.security.name}")
)
@SecuritySchemes({@SecurityScheme(
        // 指定 SecurityScheme 的名称(OpenAPIDefinition注解中的security属性中会引用该名称)
        name = "${custom.security.name}",
        // 指定认证类型为oauth2
        type = SecuritySchemeType.OAUTH2,
        // 设置认证流程
        flows = @OAuthFlows(
                // 设置授权码模式
                authorizationCode = @OAuthFlow(
                        // 获取token地址
                        tokenUrl = "${custom.security.token-url}",
                        // 授权申请地址
                        authorizationUrl = "${custom.security.authorization-url}",
                        // oauth2的申请的scope(需要在OAuth2客户端中存在)
                        scopes = {
                                @OAuthScope(name = "openid", description = "OpenId登录"),
                                @OAuthScope(name = "profile", description = "获取用户信息"),
                                @OAuthScope(name = "message.read", description = "读"),
                                @OAuthScope(name = "message.write", description = "写")
                        }
                )
        )
)})
public class SpringDocAnnoConfig {
}

yml中的配置

custom:
  info:
    title: example-api
    version: 0.0.1
    description: 这是一个使用SpringDoc生成的在线文档.
    terms-of-service: http://127.0.0.1:8080/example/test01
  license:
    name: Apache 2.0
  security:
    name: Authenticate
    token-url: http://kwqqr48rgo.cdhttp.cn/oauth2/token
    authorization-url: http://kwqqr48rgo.cdhttp.cn/oauth2/authorize

注意：要想请求时携带登录获取的access_token，@OpenAPIDefinition注解中必须指定security属性，并且name值要和@SecurityScheme注解中的name属性一致。

还有一件事，@SecuritySchemes注解可以直接替换为@SecurityScheme注解，只指定一种认证方式。

还有一件事，使用注解的方式可以直接从yml中获取yml配置文件中的值，当然也可以直接使用具体的常量值(e.g. @License注解中的url属性)。

还有一件事，如果该配置类上只有@OpenAPIDefinition或 @SecurityScheme注解，并且该配置类中没有任何实现，则该配置类会在本机编译时消失，请添加@Configuration注解避免这种情况。
官网原文：If you give @OpenAPIDefinition or @SecurityScheme to a class that has no implementation, that class will disappear when you natively compile. To avoid this, give the class a @Configuration.

还有一件事…

Java代码配置

这里的注意事项和上边注解配置是一样的，不过由注解转为了Java类。

配置方式如下代码所示，详细内容请看代码中的注释

package com.example.config;

import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.security.OAuthFlow;
import io.swagger.v3.oas.models.security.OAuthFlows;
import io.swagger.v3.oas.models.security.Scopes;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Spring Doc OpenApi Java代码配置
 *
 * @author vains
 */
@Configuration
public class SpringDocBeanConfig {

    @Bean
    public OpenAPI customOpenAPI() {
        // 基础信息
        Info info = new Info()
                .title("example-api-java")
                .version("0.0.1")
                .description("这是一个使用SpringDoc生成的在线文档.")
                .termsOfService("http://127.0.0.1:8080/example/test01")
                .license(new License().name("Apache 2.0").url("http://127.0.0.1:8080/example/test01"));

        // 组件
        Components components = new Components();
        // 安全认证组件
        SecurityScheme securityScheme = new SecurityScheme();

        // 创建一个oauth认证流程
        OAuthFlows oAuthFlows = new OAuthFlows();
        // 设置OAuth2流程中认证服务的基本信息
        OAuthFlow oAuthFlow = new OAuthFlow()
                // 授权申请地址
                .authorizationUrl("http://kwqqr48rgo.cdhttp.cn/oauth2/authorize")
                // 获取token地址
                .tokenUrl("http://kwqqr48rgo.cdhttp.cn/oauth2/token")
                .scopes(new Scopes()
                        .addString("openid", "OpenId登录")
                        .addString("profile", "获取用户信息")
                        .addString("message.read", "读")
                        .addString("message.write", "写")
                );
        // 使用授权码模式
        oAuthFlows.authorizationCode(oAuthFlow);

        // OAuth2流程
        securityScheme.flows(oAuthFlows)
                .type(SecurityScheme.Type.OAUTH2);

        // 安全认证名
        String securityName = "Authenticate";
        // 将认证配置加入组件中
        components.addSecuritySchemes(securityName, securityScheme);

        SecurityRequirement securityRequirement = new SecurityRequirement();
        // 将安全认证和swagger-ui关联起来
        securityRequirement.addList(securityName);
        return new OpenAPI()
                // 基础描述信息
                .info(info)
                // 添加OAuth2认证流程组件
                .components(components)
                // 添加请求时携带OAuth2规范的请求头(通过OAuth2流程获取token后发请求时会自动携带Authorization请求头)
                .addSecurityItem(securityRequirement);
    }

}

效果预览

启动项目后打开提供的在线文档地址：

http://127.0.0.1:8080/swagger-ui/index.html
效果展示

右侧多了一个Authorize按钮。
操作演示流程如下
操作演示

其它基础配置

关于springdoc-openapi-core-properties和swagger-ui properties在官网中有详细的介绍了，就不展开说明了，读者可以对照文档在yml中添加自己的相关配置。

附录

  1. SpringDoc官网
  2. 代码仓库：Gitee、Github

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

远程数据采集继电器RTU如何应用在智能电动汽车充电桩

远程数据采集继电器RTU如何应用在智能电动汽车充电桩

远程数据采集继电器（Remote Terminal Unit，RTU）在智能电动汽车充电桩中的应用，可以为充电桩系统提供更高效、安全和可靠的远程监控与控制功能。下面将详细说明RTU在智能电动汽车充电桩中的应用。 远程监控功能： RTU可以…
阅读更多...
一份WhatsApp矩阵账号营销模式全解，有你不知道的玩法吗？

一份WhatsApp矩阵账号营销模式全解，有你不知道的玩法吗？

将WhatsApp营销践行到底，是傲途针对海外Social营销一直在做的事。在WhatsApp全球营销范围越来越广泛、营销模式越来越深入的当下，我们也在实践中积累了一套比较系统而全面的差异化矩阵营销模式，帮助大中小不同类型企业获得了有价值的结果。 …
阅读更多...
前后端黄金组合：Django+Vue+Element UI，助你构建完美平台！

前后端黄金组合：Django+Vue+Element UI，助你构建完美平台！

这是一篇什么文章？ 一篇你对测试开发工作感兴趣，想了解系统工作逻辑的文章。 一篇是你在开始动手搭建环境前需要了解各工具原理的文章。 这是一篇你真正开始前需要查阅的文章。 本文介绍了前后端工作原理，前后端搭建的流程、搭建过程中需…
阅读更多...
使用 Amazon VPS 探索存储选项：实用指南

使用 Amazon VPS 探索存储选项：实用指南

文章作者：Libai 在这个数字化时代，云计算已经成为了企业的必需品，它为我们带来了可扩展性、灵活性和成本效益。作为一家领先的云服务提供商，亚马逊网络服务（Amazon Web Services）提供了各种各样的服务&…
阅读更多...
当绿色积分合法化遇上消费增值，会擦出什么样的火花！

当绿色积分合法化遇上消费增值，会擦出什么样的火花！

亲爱的消费者朋友们，你们好！今天我要向你们揭示一种全新的消费理念——消费增值，让每一次消费都变得更有价值！ 在传统的消费观念中，我们仅仅用金钱购买物品或享受服务，然后这些物品和服务便从我们的生活中消…
阅读更多...
高压功率放大器有什么作用和用途

高压功率放大器有什么作用和用途

高压功率放大器是一种专门用于放大高电压和高功率信号的电子器件，其主要作用是将输入信号放大到足够的范围内，以便后续电路进行进一步处理。在工业、医疗、军事等领域中，高压功率放大器有着广泛的应用。 下面介绍几个高压功率放大器的应用场景…
阅读更多...
数据结构与算法之美学习笔记：23 | 二叉树基础（上）：什么样的二叉树适合用数组来存储？

数据结构与算法之美学习笔记：23 | 二叉树基础（上）：什么样的二叉树适合用数组来存储？

目录 前言树（Tree）二叉树（Binary Tree）二叉树的遍历解答开篇 & 内容小结 前言 本节课程思维导图： 前面我们讲的都是线性表结构，栈、队列、链表等等。今天我们讲一种非线性表结构，树。问题&…
阅读更多...
el-table实现表格内嵌套表格

el-table实现表格内嵌套表格

文章目录 一、效果图二、使用场景三、所用组件元素（Elementui）四、代码部分 一、效果图 二、使用场景 🛀el-form 表单内嵌套el-table表格 🛀el-table 表格内又嵌套el-table表格 三、所用组件元素（Elementui&#xff…
阅读更多...
滚珠螺杆在航天工业领域中的重要性

滚珠螺杆在航天工业领域中的重要性

滚珠螺杆是重要的航天工业配件之一，在航天工业领域中具有非常重要的地位和作用。 首先，滚珠螺杆作为一种高精度、高刚度的传动元件，能够提供准确的传动和定位精度，从而保证航天器的可靠性和性能。航天器在飞行过程中需要精确控制其…
阅读更多...
分形简单版

分形简单版

我的代码&#xff1a; #include<bits/stdc.h> using namespace std; const int N1000; int n; char s[N][N]; void work(int x) {if(x1) {s[0][0]*;return;}work(x-1);for(int i0;i<(1<<x-2);i)for(int j(1<<x-2);j<(1<<x-1);j) s[i][j]s[i][j-(…
阅读更多...
网络工程师网络配置经典例题（二）

网络工程师网络配置经典例题（二）

目录 1、access、trunk 2、配置终结子接口 3、DHCP接口地址池、DNS 4、静态默认路由、接口IP 5、ACL、NAT 使内网用户可以访问外网 6、VLANIF 某公司拥有多个部门且位于不同网段&#xff0c;各部门均有访问Internet的需求。现要求用户通过二层交换机和路由器访问外部网络…
阅读更多...
由两个独立的高增益运算放大器组成的运放芯片D258，可应用于音频信号处理系统上

由两个独立的高增益运算放大器组成的运放芯片D258，可应用于音频信号处理系统上

D258是由两个独立的高增益运算放大器组成。可以是单电源工作&#xff0c;也可以是双电源工作,电源的电流消耗与电源电压大小无关。应用范围包括变频放大器、DC增益部件和所有常规运算放大电路。 主要特点&#xff1a; ● 可单电源或双电源 工作 ● 在一个封装内的两个经…
阅读更多...
TikTok Shop印尼站关闭给所有跨境卖家的警示（附止损解决方案）

TikTok Shop印尼站关闭给所有跨境卖家的警示（附止损解决方案）

01关店事件回顾 10月3日&#xff0c;印尼TikTok卖家迎来了他们的至暗时刻&#xff1a;官方邮件通知明确告知所有人&#xff0c;TikTok Shop于10月4日印尼西部时间17点正式关闭。 至此&#xff0c;TikTok在印尼成为不再拥有“电商功能”的短视频内容平台&#xff0c;所有人都可…
阅读更多...
sql注入 [极客大挑战 2019]HardSQL1

sql注入 [极客大挑战 2019]HardSQL1

打开题目 输入1或者1"&#xff0c;页面均回显NO,Wrong username password&#xff01;&#xff01;&#xff01; 那我们输入1 试试万能密码 1 or 11 # 输入1 and 12 # 输入1 union select 1,2,3 # 输入1 ununionion seselectlect 1,2,3 # 输入1 # 输入1# 页面依旧回…
阅读更多...
虾皮台湾站点如何选品

虾皮台湾站点如何选品

在互联网时代&#xff0c;电商平台成为了越来越多人购物的首选。虾皮作为台湾地区最大的电商平台之一&#xff0c;为商家提供了良好的销售渠道。然而&#xff0c;在虾皮上选择适合的商品对于商家来说并不容易。本文将介绍如何通过虾皮选品工具-知虾来查看台湾地区各大类目的热销…
阅读更多...
day30_servlet

day30_servlet

今日内容 零、复习昨日 一、接收请求 二、处理响应 三、综合案例 零、复习昨日 画图, 请求处理的完整流程(javaweb开发流程) 零、注解改造 WebServlet注解,相当于是在web.xml中配置的servlet映射 Servlet类 package com.qf.servlet;import javax.servlet.ServletException; im…
阅读更多...
移动端获取ua头的值

移动端获取ua头的值

目录&#xff1a; 1、检测地址2、测试结果 1、检测地址 http://www.ip138.com/useragent/ 2、测试结果 成功的拿到了ua头的值了&#xff0c;亲测可行&#xff01;&#xff01;&#xff01;
阅读更多...
如何写好一篇软文？怎样写软文比较有吸引力？

如何写好一篇软文？怎样写软文比较有吸引力？

软文&#xff0c;即柔性广告&#xff0c;是一种通过文字、图片等形式&#xff0c;将广告信息融入到内容中&#xff0c;以达到宣传、推广、营销目的的文章。企业和品牌每天都会在互联网上投放大量软文&#xff0c;软文起到润物细无声的作用&#xff0c;可以在无形中影响用户心智…
阅读更多...
使用 Splashtop 的开放 API 简化 IT 工作流程

使用 Splashtop 的开放 API 简化 IT 工作流程

我们的工作方式在不断变化&#xff0c;IT 技术人员必须迅速适应时代的变化。越来越多的公司正在转向混合和远程策略&#xff0c;这为那些在服务台或IT技术人员工作的人增加了额外的工作层。对于系统管理员来说&#xff0c;管理一切都可能变得更加复杂。 找到合适的软件来管理多…
阅读更多...
HarmonyOS开发：ArkTs常见数据类型（一）

HarmonyOS开发：ArkTs常见数据类型（一）

前言 无论是Android还是iOS开发&#xff0c;都提供了多种数据类型用于常见的业务开发&#xff0c;但在ArkTs中&#xff0c;数据类型就大有不同&#xff0c;比如int&#xff0c;float&#xff0c;double&#xff0c;long统一就是number类型&#xff0c;当然了也不存在char类型&a…
阅读更多...
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站