Springboot3与Knife4j(Springdoc)框架整合及Oauth2登录校验配置

作者:狼烟四起2024.01.17 07:50浏览量:8

简介:本文将介绍如何将Springboot3与Knife4j(Springdoc)框架进行整合,并配置Oauth2登录校验。通过简单的步骤和示例代码,帮助读者快速上手。

千帆应用开发平台“智能体Pro”全新上线 限时免费体验

面向慢思考场景,支持低代码配置的方式创建“智能体Pro”应用

立即体验

一、概述
随着微服务架构的兴起,Spring Boot框架已成为Java开发者的首选。而Knife4j作为一个强大的API文档生成工具,能够与Spring Boot无缝集成,提供可视化的API文档。同时,为了提高安全性,我们通常会使用Oauth2进行登录校验。本文将详细介绍如何将Spring Boot 3与Knife4j(Springdoc)框架进行整合,并配置Oauth2登录校验。
二、准备工作
首先,确保你已经安装了以下软件:

  1. Java Development Kit (JDK)
  2. Spring Boot 3
  3. Maven或Gradle
  4. Knife4j(Springdoc)
    三、整合步骤
  5. 添加依赖
    在Spring Boot项目的pom.xml文件中,添加以下依赖:
    1. <dependency>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-web</artifactId>
    4. </dependency>
    5. <dependency>
    6. <groupId>org.springframework.boot</groupId>
    7. <artifactId>spring-boot-starter-oauth2-client</artifactId>
    8. </dependency>
    9. <dependency>
    10. <groupId>org.springframework.boot</groupId>
    11. <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
    12. </dependency>
    13. <dependency>
    14. <groupId>com.github.xiaoymin</groupId>
    15. <artifactId>knife4j-spring-boot-starter</artifactId>
    16. <version>最新版本</version>
    17. </dependency>
  6. 配置资源服务器
    在Spring Boot项目的application.properties或application.yml文件中,添加以下配置:
    1. # application.properties
    2. spring.security.oauth2.resourceserver.jwt.key=你的密钥
    3. spring.security.oauth2.client.registration.your-provider.client-id=你的客户端ID
    4. spring.security.oauth2.client.registration.your-provider.client-secret=你的客户端密钥
    5. spring.security.oauth2.client.registration.your-provider.redirect-uri={baseUrl}/login/oauth2/code/{registrationId}
    6. spring.security.oauth2.client.registration.your-provider.scope=你的作用域
    7. spring.security.oauth2.client.registration.your-provider.authorization-grant-type=authorization_code
    8. spring.security.oauth2.client.registration.your-provider.authorization-url=你的OAuth2授权URL
    9. spring.security.oauth2.client.registration.your-provider.token-url=你的OAuth2令牌URL
  7. 配置API文档
    在Spring Boot项目的application.properties或application.yml文件中,添加以下配置:
    ```properties

    application.properties

    knife4j.openAPI3Version=最新版本
    k knife4j springdoc openapi url=/swagger/api/v3/swagger-ui/index${knife4j springdoc openapi urlSuffix}
    k knife4j springdoc openapi path=/swagger/api/v3/openapi{knife4j springdoc openapi pathSuffix}
    k knife4j springdoc openapi configuration={knife4j springdoc openapi configuration}
    k knife4j springdoc openapi title=你的API文档标题
    k knife4j springdoc openapi description=你的API文档描述
    k knife4j springdoc openapi version=你的API文档版本
    k knife4j springdoc openapi termsOfServiceUrl=你的服务条款URL
    k knife4j springdoc openapi contactName=你的联系人名称
    k knife4j springdoc openapi contactUrl=你的联系人URL
    k knife4j springdoc openapi contactEmail=你的联系人邮箱
    k knife4j springdoc openapi licenseName=你的许可证名称
    k knife4j springdoc openapi licenseUrl=你的许可证URL
    k knife4j springdoc openapi defaultBaseUrl=你的默认基础URL
    k knife4j springdoc openapi theme=你的主题名称
    k knife4j springdoc openapi filterClass=你的过滤器类名
    k knife4j springdoc openapi enableCORS=是否启用CORS支持(true/false)
    k knife4j spring
article bottom image

相关文章推荐

发表评论