mirror of
https://github.com/nagisa77/OpenIsle.git
synced 2026-03-08 13:00:45 +08:00
feat: add GitHub OAuth login
This commit is contained in:
13
README.md
13
README.md
@@ -20,6 +20,7 @@ OpenIsle 基于 Spring Boot 构建,提供社区后台常见的注册、登录
|
||||
* **用户体系**:注册、登录,密码使用 BCrypt 加密
|
||||
* **JWT 认证**:登录后获得 Token,接口通过 `Authorization: Bearer` 认证
|
||||
* **Google 登录**:支持使用 Google OAuth 登录
|
||||
* **GitHub 登录**:支持使用 GitHub OAuth 登录
|
||||
* **邮件通知**:抽象 `EmailSender`,默认实现基于 Resend
|
||||
* **角色权限**:内置 `ADMIN` 与 `USER`,管理员接口以 `/api/admin/**` 提供
|
||||
* **文章与评论**:支持分类、评论及多级回复
|
||||
@@ -43,10 +44,13 @@ OpenIsle 基于 Spring Boot 构建,提供社区后台常见的注册、登录
|
||||
- `MYSQL_USER`:数据库用户名
|
||||
- `MYSQL_PASSWORD`:数据库密码
|
||||
- `RESEND_API_KEY`:Resend 邮件服务 API Key
|
||||
- `COS_BASE_URL`:腾讯云 COS 访问域名
|
||||
- `GOOGLE_CLIENT_ID`:Google OAuth 客户端 ID
|
||||
- `VUE_APP_GOOGLE_CLIENT_ID`:前端 Google OAuth 客户端 ID
|
||||
- `JWT_SECRET`:JWT 签名密钥
|
||||
- `COS_BASE_URL`:腾讯云 COS 访问域名
|
||||
- `GOOGLE_CLIENT_ID`:Google OAuth 客户端 ID
|
||||
- `VUE_APP_GOOGLE_CLIENT_ID`:前端 Google OAuth 客户端 ID
|
||||
- `GITHUB_CLIENT_ID`:GitHub OAuth 客户端 ID
|
||||
- `GITHUB_CLIENT_SECRET`:GitHub OAuth 客户端密钥
|
||||
- `VUE_APP_GITHUB_CLIENT_ID`:前端 GitHub OAuth 客户端 ID
|
||||
- `JWT_SECRET`:JWT 签名密钥
|
||||
- `JWT_EXPIRATION`:JWT 过期时间(毫秒)
|
||||
- `PASSWORD_STRENGTH`:密码强度(LOW、MEDIUM、HIGH)
|
||||
- `CAPTCHA_ENABLED`:是否启用验证码(true/false)
|
||||
@@ -68,6 +72,7 @@ mvn spring-boot:run
|
||||
- `POST /api/auth/register`:注册新用户
|
||||
- `POST /api/auth/login`:登录并获取 Token
|
||||
- `POST /api/auth/google`:Google 登录并获取 Token
|
||||
- `POST /api/auth/github`:GitHub 登录并获取 Token
|
||||
- `GET /api/config`:查看验证码开关配置
|
||||
- 需要认证的接口示例:`GET /api/hello`(需 `Authorization` 头)
|
||||
- 管理员接口示例:`GET /api/admin/hello`
|
||||
|
||||
Reference in New Issue
Block a user