9c1dc4fbd7
- 创建信息记录文档，包含项目管理要求、产物范围、Git仓库、制品仓库信息 - 添加服务器部署信息，包括应用服务器、MySQL/Redis服务器、Jenkins服务配置 - 记录邮件服务、DNS/HTTPS证书配置及安全备注 - 创建API联调文档，包含线上入口、ID约定、初始化管理员账号信息 - 添加统一响应格式、常见错误码、鉴权规则说明 - 提供核心接口清单，涵盖tenant-service、im-service、push-service等服务 - 补充curl示例，包含运营平台登录、IM登录、会话管理等操作示例 - 实现会话控制器，支持置顶、免打扰、标记已读、草稿等功能 - 添加全局异常处理器，统一处理业务异常和参数校验错误 - 创建IM管理控制器，提供用户管理、好友请求、黑名单等管理功能
94 行
3.0 KiB
TypeScript
94 行
3.0 KiB
TypeScript
import { defineConfig } from 'vitepress'
|
|
|
|
export default defineConfig({
|
|
title: 'XuqmGroup 开发者文档',
|
|
description: 'XuqmGroup 多端 SDK 接入指南',
|
|
base: '/docs/',
|
|
lang: 'zh-CN',
|
|
ignoreDeadLinks: true,
|
|
|
|
themeConfig: {
|
|
logo: '/logo.svg',
|
|
siteTitle: 'XuqmGroup Dev Docs',
|
|
|
|
nav: [
|
|
{ text: '快速开始', link: '/guide/quickstart' },
|
|
{ text: '演示项目', link: '/demo/' },
|
|
{
|
|
text: 'SDK',
|
|
items: [
|
|
{ text: 'Android', link: '/android/' },
|
|
{ text: 'iOS', link: '/ios/' },
|
|
{ text: 'React Native', link: '/rn/' },
|
|
{ text: 'Vue3', link: '/vue3/' },
|
|
{ text: 'HarmonyOS', link: '/harmony/' },
|
|
],
|
|
},
|
|
{ text: 'API 速查', link: '/server/api' },
|
|
{ text: '平台控制台', link: 'https://dev.xuqinmin.com', target: '_blank' },
|
|
],
|
|
|
|
sidebar: {
|
|
'/guide/': [
|
|
{ text: '快速开始', link: '/guide/quickstart' },
|
|
{ text: '平台概念', link: '/guide/concepts' },
|
|
{ text: '接入流程', link: '/guide/flow' },
|
|
],
|
|
'/demo/': [
|
|
{ text: '演示项目', link: '/demo/' },
|
|
],
|
|
'/android/': [
|
|
{ text: '概览', link: '/android/' },
|
|
{ text: '安装配置', link: '/android/setup' },
|
|
{ text: 'IM 接入', link: '/android/im' },
|
|
{ text: '推送接入', link: '/android/push' },
|
|
{ text: '版本管理', link: '/android/update' },
|
|
{ text: 'API Reference', link: '/android/api' },
|
|
],
|
|
'/ios/': [
|
|
{ text: '概览', link: '/ios/' },
|
|
{ text: '安装配置', link: '/ios/setup' },
|
|
{ text: 'IM 接入', link: '/ios/im' },
|
|
{ text: '推送接入', link: '/ios/push' },
|
|
{ text: '版本管理', link: '/ios/update' },
|
|
{ text: 'API Reference', link: '/ios/api' },
|
|
],
|
|
'/rn/': [
|
|
{ text: '概览', link: '/rn/' },
|
|
{ text: '安装配置', link: '/rn/setup' },
|
|
{ text: 'IM 接入', link: '/rn/im' },
|
|
{ text: '群聊', link: '/rn/group' },
|
|
{ text: '版本管理', link: '/rn/update' },
|
|
{ text: 'API Reference', link: '/rn/api' },
|
|
],
|
|
'/vue3/': [
|
|
{ text: '概览', link: '/vue3/' },
|
|
{ text: '安装配置', link: '/vue3/setup' },
|
|
{ text: 'IM 接入', link: '/vue3/im' },
|
|
{ text: 'API Reference', link: '/vue3/api' },
|
|
],
|
|
'/harmony/': [
|
|
{ text: '概览', link: '/harmony/' },
|
|
{ text: '安装配置', link: '/harmony/setup' },
|
|
{ text: 'IM 接入', link: '/harmony/im' },
|
|
],
|
|
'/server/': [
|
|
{ text: 'API 速查', link: '/server/api' },
|
|
{ text: 'WebSocket', link: '/server/websocket' },
|
|
{ text: '错误码', link: '/server/errors' },
|
|
],
|
|
},
|
|
|
|
socialLinks: [
|
|
{ icon: 'github', link: 'https://xuqinmin.com/xuqinmin12' },
|
|
],
|
|
|
|
footer: {
|
|
message: 'XuqmGroup 开放平台',
|
|
copyright: 'Copyright © 2026 XuqmGroup',
|
|
},
|
|
|
|
search: { provider: 'local' },
|
|
},
|
|
})
|
