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

feat: Enhance OAuth 2.0 documentation and user session metadata

Browse Source
This commit is contained in:
wood chen 2025-02-17 05:14:04 +08:00
parent 84e8adf285
commit 08be0879f2
2 changed files with 60 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -95,7 +95,9 @@ export default function IndexPage() {
{/* API Example */}
<div className="mt-20">
<div className="rounded-xl bg-gray-900 p-8">
<h3 className="mb-4 text-xl font-bold text-white">示例代码</h3>
<h3 className="mb-4 text-xl font-bold text-white">
OAuth 2.0 认证流程
</h3>
<div className="mb-4 rounded-lg border border-yellow-600 bg-yellow-600/10 p-4 text-yellow-600">
<p className="text-sm">
<strong>重要提示：</strong>{" "}
@ -104,30 +106,69 @@ export default function IndexPage() {
</p>
</div>
<pre className="overflow-x-auto text-sm text-gray-300">
<code>{`// 1. 重定向到授权页面（必须通过浏览器重定向，不能使用 AJAX/Fetch）
<code>{`// 1. 重定向到授权页面
window.location.href = 'https://connect.q58.club/oauth/authorize?' + new URLSearchParams({
response_type: 'code',
client_id: 'your_client_id',
redirect_uri: 'https://your-app.com/callback'
response_type: 'code', // 必填，固定值 'code'
client_id: 'your_client_id',// 必填，在控制台获取的客户端ID
redirect_uri: 'https://your-app.com/callback' // 必填，授权后的回调地址
});
// 2. 在回调页面获取访问令牌
// 2. 获取访问令牌
const response = await fetch('https://connect.q58.club/api/oauth/access_token', {
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
code: '授权码',
redirect_uri: 'https://your-app.com/callback'
code: '授权码', // 上一步回调地址获取的 code 参数
redirect_uri: 'https://your-app.com/callback' // 必须与授权请求中的一致
})
});
const { access_token } = await response.json();
// 返回数据示例:
{
"access_token": "at_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", // 访问令牌
"token_type": "bearer", // 令牌类型
"expires_in": 604800 // 令牌有效期(秒)
}
// 3. 获取用户信息
const userInfo = await fetch('https://connect.q58.club/api/oauth/user', {
headers: {
'Authorization': \`Bearer \${access_token}\`
'Authorization': \`Bearer \${access_token}\` // 使用上一步获取的访问令牌
}
}).then(res => res.json());`}</code>
}).then(res => res.json());
// 返回数据示例:
{
"id": "user_xxxxxx", // 用户唯一标识
"email": "user@example.com", // 用户邮箱
"username": "username", // 用户名
"name": "用户昵称", // 用户昵称
"avatarUrl": "https://...", // 头像URL
"admin": false, // 是否是管理员
"moderator": false, // 是否是版主
"groups": ["group1", "group2"] // 用户所属的论坛用户组
}`}</code>
</pre>
<div className="mt-4 space-y-2 text-sm text-gray-400">
<p>
<strong>权限说明：</strong>
</p>
<ul className="list-inside list-disc space-y-1">
<li>read_profile - 获取用户基本信息，包括邮箱、用户名等</li>
<li>groups - 获取用户所属的论坛用户组信息</li>
<li>admin - 获取用户的管理权限状态</li>
</ul>
<p className="mt-4">
<strong>安全建议：</strong>
</p>
<ul className="list-inside list-disc space-y-1">
<li>请务必在服务器端验证 access_token 的有效性</li>
<li>建议使用 HTTPS 确保数据传输安全</li>
<li>请妥善保管 client_secret，不要泄露给客户端</li>
</ul>
</div>
</div>
</div>
</div>

8
src/auth.ts
View File

@ -32,6 +32,12 @@ export const { handlers, auth, signIn, signOut } = NextAuth({
if (token.role) {
session.user.role = token.role;
}
if (token.moderator !== undefined) {
session.user.moderator = token.moderator;
}
if (token.groups) {
session.user.groups = token.groups;
}
session.user.name = token.name;
return session;
@ -47,6 +53,8 @@ export const { handlers, auth, signIn, signOut } = NextAuth({
token.picture = dbUser.avatarUrl;
token.name = dbUser.name;
token.role = dbUser.role;
token.moderator = dbUser.moderator;
token.groups = dbUser.groups;
return token;
},