Open WebUI 集成企业微信认证开发文档

Open WebUI 集成企业微信认证开发文档

1. 体系架构

1.1 技术栈

• 前端: Vue3 + TypeScript
  
• 后端: FastAPI
  
• 数据库: PostgreSQL
  
• 缓存: Redis
  
• 认证: 企业微信 OAuth2.0
  

1.2 体系模块

     2. 数据库设计

1. -- 用户表
2. CREATE TABLE users (
3.     id SERIAL PRIMARY KEY,
4.     wecom_userid VARCHAR(64) UNIQUE NOT NULL,
5.     name VARCHAR(100) NOT NULL,
6.     avatar_url TEXT,
7.     department JSON,
8.     created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
9.     last_login_at TIMESTAMP WITH TIME ZONE
10. );
12. -- 会话表
13. CREATE TABLE chat_sessions (
14.     id SERIAL PRIMARY KEY,
15.     user_id INTEGER REFERENCES users(id),
16.     title VARCHAR(200),
17.     model VARCHAR(50),
18.     created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
19.     updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
20. );
22. -- 消息表
23. CREATE TABLE messages (
24.     id SERIAL PRIMARY KEY,
25.     session_id INTEGER REFERENCES chat_sessions(id),
26.     role VARCHAR(20) CHECK (role IN ('user', 'assistant', 'system')),
27.     content TEXT,
28.     created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
29. );

复制代码

3. 后端实现

3.1 配置文件

1. from pydantic_settings import BaseSettings
3. class Settings(BaseSettings):
4.     # 数据库配置
5.     DATABASE_URL: str = "postgresql://user:password@localhost:5432/openwebui"
6.    
7.     # Redis配置
8.     REDIS_URL: str = "redis://localhost:6379"
9.    
10.     # 企业微信配置
11.     WECOM_CORPID: str
12.     WECOM_CORPSECRET: str
13.     WECOM_AGENT_ID: int
14.     WECOM_REDIRECT_URI: str
15.    
16.     # JWT配置
17.     JWT_SECRET_KEY: str
18.     JWT_ALGORITHM: str = "HS256"
19.     ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 24
21.     class Config:
22.         env_file = ".env"

复制代码

3.2 认证服务

1. from fastapi import HTTPException
2. import httpx
3. from typing import Dict
5. class WecomAuthService:
6.     def __init__(self, settings):
7.         self.settings = settings
8.         self.access_token = None
9.         
10.     async def get_access_token(self) -> str:
11.         async with httpx.AsyncClient() as client:
12.             response = await client.get(
13.                 "https://qyapi.weixin.qq.com/cgi-bin/gettoken",
14.                 params={
15.                     "corpid": self.settings.WECOM_CORPID,
16.                     "corpsecret": self.settings.WECOM_CORPSECRET
17.                 }
18.             )
19.             data = response.json()
20.             if data.get("errcode") != 0:
21.                 raise HTTPException(status_code=401, detail="获取access_token失败")
22.             return data["access_token"]
23.    
24.     async def get_user_info(self, code: str) -> Dict:
25.         token = await self.get_access_token()
26.         async with httpx.AsyncClient() as client:
27.             response = await client.get(
28.                 "https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo",
29.                 params={
30.                     "access_token": token,
31.                     "code": code
32.                 }
33.             )
34.             return response.json()

复制代码

3.3 数据模型

1. from sqlalchemy import Column, Integer, String, DateTime
2. from sqlalchemy.sql import func
3. from .database import Base
5. class User(Base):
6.     __tablename__ = "users"
7.    
8.     id = Column(Integer, primary_key=True, index=True)
9.     wecom_userid = Column(String, unique=True, index=True)
10.     name = Column(String)
11.     avatar_url = Column(String)
12.     created_at = Column(DateTime(timezone=True), server_default=func.now())
13.     last_login_at = Column(DateTime(timezone=True), onupdate=func.now())

复制代码

4. 前端实现

4.1 登录组件

1. <!-- filepath: /frontend/src/components/WecomLogin.vue -->
2. <template>
3.   <div class="login-container">
4.     <a-button type="primary" @click="handleLogin">
5.       企业微信登录
6.     </a-button>
7.   </div>
8. </template>
10. <script setup lang="ts">
11. import { useAuth } from '@/composables/useAuth'
13. const { loginWithWecom } = useAuth()
15. const handleLogin = () => {
16.   const redirect_uri = encodeURIComponent(window.location.origin + '/auth/callback')
17.   const url = `https://open.work.weixin.qq.com/wwopen/sso/qrConnect?appid=${import.meta.env.VITE_WECOM_CORPID}&agentid=${import.meta.env.VITE_WECOM_AGENT_ID}&redirect_uri=${redirect_uri}`
18.   window.location.href = url
19. }
20. </script>

复制代码

4.2 用户状态管理

1. import { defineStore } from 'pinia'
3. export const useAuthStore = defineStore('auth', {
4.   state: () => ({
5.     user: null,
6.     token: null,
7.   }),
8.   
9.   actions: {
10.     async login(code: string) {
11.       try {
12.         const response = await fetch('/api/auth/wecom/login', {
13.           method: 'POST',
14.           headers: {
15.             'Content-Type': 'application/json',
16.           },
17.           body: JSON.stringify({ code }),
18.         })
19.         const data = await response.json()
20.         this.token = data.token
21.         this.user = data.user
22.         localStorage.setItem('token', data.token)
23.       } catch (error) {
24.         console.error('登录失败:', error)
25.         throw error
26.       }
27.     },
28.   },
29. })

复制代码

5. 部署说明

5.1 环境要求

• Python 3.8+
  
• Node.js 16+
  
• PostgreSQL 13+
  
• Redis 6+
  

5.2 安装步调

• 克隆项目并安装依靠
  

1. git clone https://github.com/open-webui/open-webui.git
2. cd open-webui
4. # 后端依赖
5. cd backend
6. pip install -r requirements.txt
8. # 前端依赖
9. cd ../frontend
10. npm install

复制代码

• 配置环境变量
  

1. DATABASE_URL=postgresql://user:password@localhost:5432/openwebui
2. REDIS_URL=redis://localhost:6379
3. WECOM_CORPID=your_corpid
4. WECOM_CORPSECRET=your_secret
5. WECOM_AGENT_ID=your_agent_id
6. JWT_SECRET_KEY=your_secret_key

复制代码

• 初始化数据库
  

1. cd backend
2. alembic upgrade head

复制代码

• 启动服务
  

1. # 后端服务
2. uvicorn main:app --host 0.0.0.0 --port 8000
4. # 前端服务
5. cd ../frontend
6. npm run dev

复制代码

6. 测试计划

6.1 单位测试

1. import pytest
2. from services.auth import WecomAuthService
4. async def test_wecom_auth():
5.     service = WecomAuthService(settings)
6.     token = await service.get_access_token()
7.     assert token is not None

复制代码

6.2 集成测试查抄清单

• 企业微信扫码登录流程
  
• 用户信息同步
  
• 会话持久化
  
• Token 过期处置处罚
  
• 并发会话管理
  

7. 安全考虑

• 所有API请求需要JWT认证
  
• 使用HTTPS进行传输加密
  
• 实现请求频率限定
  
• 定期清理过期会话
  
• 敏感信息加密存储
  

8. 维护建议

• 定期备份数据库
  
• 监控体系资源使用
  
• 纪录详细的操纵日志
  
• 定期更新依靠包
  
• 制定故障规复方案
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。