Swagger UI 集成 OAuth2 授权服务

最新推荐文章于 2025-06-17 11:45:40 发布

四气

最新推荐文章于 2025-06-17 11:45:40 发布

阅读量2.1w

点赞数 2

CC 4.0 BY-SA版权

分类专栏： MCloud 文章标签： spring boot oauth2 swagger java8 microservice

本文链接：https://blog.youkuaiyun.com/github_39939645/article/details/80114248

本文介绍了如何在Spring Boot应用中结合Swagger UI与OAuth2进行API测试。使用环境包括Java8、Spring Boot 2.0、Spring OAuth2和Keycloak作为OAuth2认证服务器。配置包括Swagger的YAML配置以及在Keycloak客户端设置中配置Swagger的回调地址，以允许跨域。完成设置后，用户可以通过Swagger UI进行授权登录，并在访问受保护的API时，Swagger会自动添加OAuth2令牌。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在开发 Rest API 时，经常会使用 swagger 进行 API 测试，但是 API 通常情况下都是受保护的，需要携带 token 才能访问，本篇文章将介绍在 Spring Boot 中，swagger 怎样与 OAuth2 服务集成。

本文所使用的环境：

Java8
Spring Boot 2.0
Spring OAuth2
Keycloak OAuth2 认证服务器
Gradle

首先是 swagger 的配置：

package me.javaroad.mcloud.apigw.config;

import com.google.common.collect.Lists;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.OAuthBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.AuthorizationCodeGrant;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.GrantType;
import springfox.documentation.service.Secur