Skip to content

OAuth Client SDK(oauth-parent)

面向“组织授权与审计平台”的 OAuth2 客户端 SDK(Java 为主),提供以 Filter/Servlet 为核心的低侵入式接入方式,并配套常用框架的集成模块与对接文档。

目录结构

  • oauth-client/:核心 SDK(OAuth2 授权码模式、回调处理、会话转换、基础能力)
  • oauth-modules/:框架/场景扩展(Spring、Spring Boot、Shiro、NodeJS 等)
  • oauth-camera/:示例工程(包含资源与前端示例)
  • docs/:对接文档与 FAQ(本仓库内置的 Markdown 文档)

快速开始(构建)

环境要求:JDK 8+、Maven 3.6+

bash
mvn -DskipTests clean install

依赖引用(示例)

以 Maven 为例(版本与仓库发布保持一致,当前父工程版本见根 pom.xml):

xml
<dependency>
  <groupId>group.flyfish.oauth</groupId>
  <artifactId>oauth-client</artifactId>
  <version>1.0.7</version>
</dependency>

不同框架请按需选择 oauth-modules/ 下的对应模块(例如 Spring Boot、Shiro 等),并参考 docs/ 中的对接说明。

文档(README + docs 统一入口)

本仓库已使用 VitePress 初始化文档站点:

  • docs/ 目录下的 Markdown 会自动生成侧边栏
  • 文档首页会直接复用根目录的 README.md

本地启动文档(需要 Node.js 18+):

bash
npm install
npm run docs:dev

构建静态站点:

bash
npm run docs:build

许可证

Apache License 2.0,详见 LICENSE