wood/Q58Connect
1
0
Fork 0
mirror of https://github.com/woodchen-ink/Q58Connect.git synced 2025-07-18 14:01:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update OAuth 2.0 documentation with detailed error codes and security guidelines

Browse Source
This commit is contained in:
wood chen 2025-02-17 05:20:27 +08:00
parent 08be0879f2
commit 25f262c1ac
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/app/()/page.tsx
View File

@ -127,9 +127,9 @@ const response = await fetch('https://connect.q58.club/api/oauth/access_token',
// 返回数据示例: // 返回数据示例:
{ {
"access_token": "at_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", // 访问令牌 "access_token": "at_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", // 访问令牌，以 at_ 开头
"token_type": "bearer", // 令牌类型 "token_type": "bearer", // 令牌类型
"expires_in": 604800 // 令牌有效期(秒) "expires_in": 604800 // 令牌有效期(秒)，默认7天
} }
// 3. 获取用户信息 // 3. 获取用户信息
@ -145,7 +145,7 @@ const userInfo = await fetch('https://connect.q58.club/api/oauth/user', {
"email": "user@example.com", // 用户邮箱 "email": "user@example.com", // 用户邮箱
"username": "username", // 用户名 "username": "username", // 用户名
"name": "用户昵称", // 用户昵称 "name": "用户昵称", // 用户昵称
"avatarUrl": "https://...", // 头像URL "avatar_url": "https://...", // 头像URL
"admin": false, // 是否是管理员 "admin": false, // 是否是管理员
"moderator": false, // 是否是版主 "moderator": false, // 是否是版主
"groups": ["group1", "group2"] // 用户所属的论坛用户组 "groups": ["group1", "group2"] // 用户所属的论坛用户组
@ -161,12 +161,23 @@ const userInfo = await fetch('https://connect.q58.club/api/oauth/user', {
<li>admin - 获取用户的管理权限状态</li> <li>admin - 获取用户的管理权限状态</li>
</ul> </ul>
<p className="mt-4"> <p className="mt-4">
<strong>安全建议：</strong> <strong>安全说明：</strong>
</p> </p>
<ul className="list-inside list-disc space-y-1"> <ul className="list-inside list-disc space-y-1">
<li>请务必在服务器端验证 access_token 的有效性</li> <li>授权码(code)是一次性的，使用后立即失效</li>
<li>授权码有效期为10分钟</li>
<li>access_token 有效期为7天，请在过期前重新获取</li>
<li>请确保回调地址(redirect_uri)与应用注册时完全一致</li>
<li>建议使用 HTTPS 确保数据传输安全</li> <li>建议使用 HTTPS 确保数据传输安全</li>
<li>请妥善保管 client_secret，不要泄露给客户端</li> </ul>
<p className="mt-4">
<strong>错误说明：</strong>
</p>
<ul className="list-inside list-disc space-y-1">
<li>400 Invalid code params - 授权码参数缺失</li>
<li>400 Invalid code credentials - 授权码无效或已过期</li>
<li>400 Invalid redirect uri - 回调地址不匹配</li>
<li>401 Invalid access token - 访问令牌无效或已过期</li>
</ul> </ul>
</div> </div>
</div> </div>