Files
djangoadmin-wiki/DjangoAdmin_FastAPI_EleVue/.vitepress/config/zh.ts
T
2026-09-14 08:46:32 +08:00

845 lines
31 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import type { DefaultTheme, LocaleSpecificConfig } from "vitepress";
export const META_URL = "https://www.djangoadmin.cn";
export const META_TITLE = "企业级中台解决方案";
export const META_DESCRIPTION = "企业级中台解决方案";
export const zhConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
description: META_DESCRIPTION,
head: [
["meta", { property: "og:url", content: META_URL }],
["meta", { property: "og:description", content: META_DESCRIPTION }],
["meta", { property: "twitter:url", content: META_URL }],
["meta", { property: "twitter:title", content: META_TITLE }],
["meta", { property: "twitter:description", content: META_DESCRIPTION }],
[
"script",
{},
`
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?4560d3a77ee7a45ae4e5dc4ad6cfd441";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
`,
],
],
themeConfig: {
editLink: {
pattern: "https://gitee.com/djangoadmin/DjangoAdmin_Fastapi_EleVue",
text: "对本页提出修改建议",
},
outline: {
label: "本页内容",
},
docFooter: {
prev: "上一页",
next: "下一页",
},
nav: [
{ text: "官网", link: "https://www.djangoadmin.cn" },
{ text: "授权", link: "https://www.djangoadmin.cn/goods/detail/2" },
{
text: "部署文档",
items: [
{
text: "DjangoAdmin混编版Django+Layui版本",
link: "http://docs.django.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+ElementPlus版本",
link: "http://docs.django.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+AntDesign版本",
link: "http://docs.django.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+NaiveUI版本",
link: "http://docs.django.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版Flask+Layui版本",
link: "http://docs.flask.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+ElementPlus版本",
link: "http://docs.flask.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+AntDesign版本",
link: "http://docs.flask.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+NaiveUI版本",
link: "http://docs.flask.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版FastAPI+Layui版本",
link: "http://docs.fastapi.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+ElementPlus版本",
link: "http://docs.fastapi.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+AntDesign版本",
link: "http://docs.fastapi.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+NaiveUI版本",
link: "http://docs.fastapi.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版Tornado+Layui版本",
link: "http://docs.tornado.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+ElementPlus版本",
link: "http://docs.tornado.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+AntDesign版本",
link: "http://docs.tornado.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+NaiveUI版本",
link: "http://docs.tornado.naivevue.djangoadmin.cn",
},
],
},
{
text: "在线演示",
items: [
{
text: "DjangoAdmin混编版Django+Layui版本",
link: "http://manage.django.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+ElementPlus版本",
link: "http://manage.django.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+AntDesign版本",
link: "http://manage.django.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Django+NaiveUI版本",
link: "http://manage.django.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版Flask+Layui版本",
link: "http://manage.flask.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+ElementPlus版本",
link: "http://manage.flask.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+AntDesign版本",
link: "http://manage.flask.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Flask+NaiveUI版本",
link: "http://manage.flask.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版FastAPI+Layui版本",
link: "http://manage.fastapi.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+ElementPlus版本",
link: "http://manage.fastapi.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+AntDesign版本",
link: "http://manage.fastapi.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离FastAPI+NaiveUI版本",
link: "http://manage.fastapi.naivevue.djangoadmin.cn",
},
{
text: "DjangoAdmin混编版Tornado+Layui版本",
link: "http://manage.tornado.layui.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+ElementPlus版本",
link: "http://manage.tornado.elevue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+AntDesign版本",
link: "http://manage.tornado.antdvue.djangoadmin.cn",
},
{
text: "DjangoAdmin前后端分离Tornado+NaiveUI版本",
link: "http://manage.tornado.naivevue.djangoadmin.cn",
},
],
},
{
text: "广告赞助",
link: "/zh/other/sponsor.html",
},
{
text: "相关链接",
items: [
{
text: "官方网站",
link: "https://www.djangoadmin.cn",
},
{
text: "Gitee 仓库",
link: "https://gitee.com/djangoadmin",
},
{
text: "FastAPI 文档",
link: "https://fastapi.tiangolo.com/zh/",
},
{
text: "Vue3 文档",
link: "https://cn.vuejs.org/",
},
{
text: "ElementPlus",
link: "https://element-plus.org/zh-CN/",
},
],
},
],
sidebar: {
"/zh/": [
// ================================================================
// 第 1 章:了解项目
// ================================================================
{
text: "📖 1. 了解项目",
collapsed: false,
items: [
{ text: "1.1 项目介绍", link: "/zh/introduction.html" },
{ text: "1.2 为什么选择我们?", link: "/zh/why.html" },
{ text: "1.3 项目目录结构", link: "/zh/struct.html" },
{ text: "1.4 新手入门指南", link: "/zh/course.html" },
{ text: "1.5 更新日志", link: "/zh/changelog.html" },
],
},
// ================================================================
// 第 2 章:快速入门
// ================================================================
{
text: "🚀 2. 快速入门",
collapsed: false,
items: [
{ text: "2.1 开发环境准备", link: "/zh/volume1/environment.html" },
{ text: "2.2 后端服务启动", link: "/zh/volume1/backend.html" },
{ text: "2.3 前端服务启动", link: "/zh/volume1/frontend.html" },
{ text: "2.4 数据库初始化", link: "/zh/volume1/database.html" },
{ text: "2.5 Docker 快速部署", link: "/zh/volume1/docker.html" },
{ text: "2.6 环境变量配置参考", link: "/zh/volume1/env-vars.html" },
{ text: "2.7 第一个接口调试", link: "/zh/volume1/first-api.html" },
{ text: "2.8 常见问题 FAQ", link: "/zh/volume1/faq.html" },
],
},
// ================================================================
// 第 3 章:模块开发实战(独立成章,新人快速上手)
// ================================================================
{
text: "🧪 3. 模块开发实战",
collapsed: false,
items: [
{ text: "3.1 概述与目标", link: "/zh/volume2/overview.html" },
{ text: "3.2 数据模型定义", link: "/zh/volume2/model.html" },
{
text: "3.3 参数验证(Pydantic Schema)",
link: "/zh/volume2/schema.html",
},
{
text: "3.4 数据访问层(Repository)",
link: "/zh/volume2/repository.html",
},
{
text: "3.5 业务逻辑层(Service)",
link: "/zh/volume2/service.html",
},
{
text: "3.6 端点层(Endpoint)",
link: "/zh/volume2/endpoint.html",
},
{ text: "3.7 路由注册", link: "/zh/volume2/router.html" },
{ text: "3.8 权限节点配置", link: "/zh/volume2/permission.html" },
{ text: "3.9 前端 API 层开发", link: "/zh/volume2/fe-api.html" },
{ text: "3.10 前端页面视图开发", link: "/zh/volume2/fe-view.html" },
{
text: "3.11 前端路由与菜单配置",
link: "/zh/volume2/fe-router.html",
},
{ text: "3.12 完整代码清单", link: "/zh/volume2/code-list.html" },
{ text: "3.13 常见问题与排错", link: "/zh/volume2/faq.html" },
],
},
// ================================================================
// 第 4 章:架构设计
// ================================================================
{
text: "🏛️ 4. 架构设计",
collapsed: false,
items: [
{ text: "4.1 整体架构概览", link: "/zh/volume3/overview.html" },
{ text: "4.2 技术选型与决策", link: "/zh/volume3/tech-stack.html" },
{ text: "4.3 请求处理链路", link: "/zh/volume3/request-flow.html" },
{ text: "4.4 分层架构详解", link: "/zh/volume3/layer-arch.html" },
{ text: "4.5 目录结构设计", link: "/zh/volume3/directory.html" },
{ text: "4.6 核心基类体系", link: "/zh/volume3/base-classes.html" },
{
text: "4.7 同步与异步编程模型",
link: "/zh/volume3/sync-async.html",
},
{ text: "4.8 缓存架构设计", link: "/zh/volume3/cache.html" },
{
text: "4.9 数据库设计",
link: "/zh/volume3/database-design.html",
},
{ text: "4.10 安全架构设计", link: "/zh/volume3/security.html" },
{ text: "4.11 扩展性设计", link: "/zh/volume3/extensibility.html" },
],
},
// ================================================================
// 第 5 章:开发指南
// ================================================================
{
text: "🛠️ 5. 开发指南",
collapsed: false,
items: [
// ------------------------------------------------------------
// 5.1 后端核心功能(按类别分组)
// ------------------------------------------------------------
{
text: "5.1 后端核心功能",
collapsed: false,
items: [
// 🔐 认证与安全
{
text: "🔐 认证与安全",
collapsed: false,
items: [
{
text: "5.1.1 用户认证(JWT)",
link: "/zh/volume4/core/jwt.html",
},
{
text: "5.1.2 认证流程实战",
link: "/zh/volume4/core/auth-flow.html",
},
{
text: "5.1.3 验证码机制",
link: "/zh/volume4/core/captcha.html",
},
{
text: "5.1.4 权限管理(RBAC)",
link: "/zh/volume4/core/rbac.html",
},
{
text: "5.1.5 跨域资源共享(CORS)",
link: "/zh/volume4/core/cors.html",
},
{
text: "5.1.6 演示模式",
link: "/zh/volume4/core/demo-mode.html",
},
],
},
// 📊 数据与配置
{
text: "📊 数据与配置",
collapsed: false,
items: [
{
text: "5.1.7 字典模块",
link: "/zh/volume4/core/dict.html",
},
{
text: "5.1.8 字典配置与使用",
link: "/zh/volume4/core/dict-guide.html",
},
{
text: "5.1.9 系统配置管理",
link: "/zh/volume4/core/config.html",
},
{
text: "5.1.10 参数验证(Pydantic)",
link: "/zh/volume4/core/validator.html",
},
],
},
// 📝 日志与监控
{
text: "📝 日志与监控",
collapsed: false,
items: [
{
text: "5.1.11 操作日志",
link: "/zh/volume4/core/operation-log.html",
},
{
text: "5.1.12 登录日志",
link: "/zh/volume4/core/login-log.html",
},
{
text: "5.1.13 异常与响应处理",
link: "/zh/volume4/core/exception.html",
},
],
},
// 🛡️ 防护与治理
{
text: "🛡️ 防护与治理",
collapsed: false,
items: [
{
text: "5.1.14 请求限流",
link: "/zh/volume4/core/rate-limit.html",
},
{
text: "5.1.15 防重复提交",
link: "/zh/volume4/core/idempotent.html",
},
],
},
],
},
// ------------------------------------------------------------
// 5.2 后端业务模块(功能索引,不重复 CRUD 细节)
// ------------------------------------------------------------
{
text: "5.2 后端业务模块",
collapsed: false,
items: [
{
text: "5.2.1 用户管理",
link: "/zh/volume4/business/user.html",
},
{
text: "5.2.2 角色管理",
link: "/zh/volume4/business/role.html",
},
{
text: "5.2.3 菜单管理",
link: "/zh/volume4/business/menu.html",
},
{
text: "5.2.4 部门/职级/岗位管理",
link: "/zh/volume4/business/dept.html",
},
{
text: "5.2.5 文章管理",
link: "/zh/volume4/business/article.html",
},
{
text: "5.2.6 公告与链接管理",
link: "/zh/volume4/business/content.html",
},
{
text: "5.2.7 行政区划管理",
link: "/zh/volume4/business/city.html",
},
{
text: "5.2.8 分类管理",
link: "/zh/volume4/business/category.html",
},
{
text: "5.2.9 定时任务",
link: "/zh/volume4/business/job.html",
},
{
text: "5.2.10 参数管理",
link: "/zh/volume4/business/param.html",
},
],
},
// ------------------------------------------------------------
// 5.3 后端通用工具(按类别分组)
// ------------------------------------------------------------
{
text: "5.3 后端通用工具",
collapsed: false,
items: [
// 📁 文件处理
{
text: "📁 文件处理",
collapsed: false,
items: [
{
text: "5.3.1 文件上传模块",
link: "/zh/volume4/tools/upload.html",
},
{
text: "5.3.2 上传配置与使用",
link: "/zh/volume4/tools/upload-guide.html",
},
{
text: "5.3.3 数据导入导出(Excel)",
link: "/zh/volume4/tools/excel.html",
},
],
},
// 🔧 核心工具
{
text: "🔧 核心工具",
collapsed: false,
items: [
{
text: "5.3.4 数据库会话管理",
link: "/zh/volume4/tools/db-session.html",
},
{
text: "5.3.5 请求参数解析",
link: "/zh/volume4/tools/request-util.html",
},
{
text: "5.3.6 密码加密与验证",
link: "/zh/volume4/tools/password.html",
},
{
text: "5.3.7 日志系统",
link: "/zh/volume4/tools/logger.html",
},
],
},
// 🧩 辅助工具
{
text: "🧩 辅助工具",
collapsed: false,
items: [
{
text: "5.3.8 富文本过滤",
link: "/zh/volume4/tools/rich-text.html",
},
{
text: "5.3.9 IP/UA 解析",
link: "/zh/volume4/tools/ip-ua.html",
},
{
text: "5.3.10 权限缓存",
link: "/zh/volume4/tools/perm-cache.html",
},
],
},
],
},
// ------------------------------------------------------------
// 5.4 前端开发(合并部分子项)
// ------------------------------------------------------------
{
text: "5.4 前端开发",
collapsed: false,
items: [
{
text: "5.4.1 环境搭建与快速上手",
link: "/zh/volume4/frontend/setup.html",
},
{
text: "5.4.2 API 层开发",
link: "/zh/volume4/frontend/api.html",
},
{
text: "5.4.3 页面视图开发",
link: "/zh/volume4/frontend/view.html",
},
{
text: "5.4.4 数据表格组件",
link: "/zh/volume4/frontend/table.html",
},
{
text: "5.4.5 表单组件",
link: "/zh/volume4/frontend/form.html",
},
{
text: "5.4.6 弹窗组件",
link: "/zh/volume4/frontend/modal.html",
},
{
text: "5.4.7 权限指令 v-perm",
link: "/zh/volume4/frontend/perm-directive.html",
},
{
text: "5.4.8 路由与菜单",
link: "/zh/volume4/frontend/router.html",
},
{
text: "5.4.9 状态管理(Store)",
link: "/zh/volume4/frontend/store.html",
},
{
text: "5.4.10 公共组件库",
link: "/zh/volume4/frontend/components.html",
},
{
text: "5.4.11 组合式函数(Hooks)",
link: "/zh/volume4/frontend/hooks.html",
},
{
text: "5.4.12 工具函数",
link: "/zh/volume4/frontend/utils.html",
},
{
text: "5.4.13 样式与主题",
link: "/zh/volume4/frontend/style.html",
},
{
text: "5.4.14 国际化(i18n)",
link: "/zh/volume4/frontend/i18n.html",
},
{
text: "5.4.15 前端构建",
link: "/zh/volume4/frontend/build.html",
},
],
},
// ------------------------------------------------------------
// 5.5 前后端联调
// ------------------------------------------------------------
{
text: "5.5 前后端联调",
collapsed: false,
items: [
{
text: "5.5.1 接口响应规范",
link: "/zh/volume4/integration/api-contract.html",
},
{
text: "5.5.2 代理配置",
link: "/zh/volume4/integration/proxy.html",
},
{
text: "5.5.3 权限节点联动",
link: "/zh/volume4/integration/perm-sync.html",
},
{
text: "5.5.4 文件上传联调",
link: "/zh/volume4/integration/upload-sync.html",
},
{
text: "5.5.5 字典数据联调",
link: "/zh/volume4/integration/dict-sync.html",
},
],
},
// ------------------------------------------------------------
// 5.6 API 接口速查表
// ------------------------------------------------------------
{
text: "5.6 API 接口速查表",
link: "/zh/volume4/api-cheatsheet.html",
},
],
},
// ================================================================
// 第 6 章:代码生成器(✨ 亮点独立成章)
// ================================================================
{
text: "🔧 6. 代码生成器",
collapsed: false,
items: [
{ text: "6.1 概述与架构", link: "/zh/volume5/overview.html" },
{ text: "6.2 CLI 命令行使用", link: "/zh/volume5/cli.html" },
{ text: "6.3 Web 管理界面", link: "/zh/volume5/web-ui.html" },
{ text: "6.4 表结构解析引擎", link: "/zh/volume5/parser.html" },
{ text: "6.5 代码生成引擎", link: "/zh/volume5/code-engine.html" },
{ text: "6.6 自定义模板开发", link: "/zh/volume5/templates.html" },
{ text: "6.7 配置文件详解", link: "/zh/volume5/config.html" },
{ text: "6.8 实战案例", link: "/zh/volume5/demo.html" },
{ text: "6.9 常见问题", link: "/zh/volume5/faq.html" },
],
},
// ================================================================
// 第 7 章:运维部署(Checklist 前置)
// ================================================================
{
text: "⚙️ 7. 运维部署",
collapsed: false,
items: [
{
text: "7.1 部署 Checklist",
link: "/zh/volume6/deploy-checklist.html",
},
{ text: "7.2 环境规划", link: "/zh/volume6/env-plan.html" },
{ text: "7.3 数据库迁移", link: "/zh/volume6/db-migrate.html" },
{ text: "7.4 Docker 容器化", link: "/zh/volume6/docker.html" },
{ text: "7.5 Nginx 反向代理", link: "/zh/volume6/nginx.html" },
{
text: "7.6 Supervisor 进程管理",
link: "/zh/volume6/supervisor.html",
},
{ text: "7.7 健康检查与监控", link: "/zh/volume6/monitoring.html" },
{
text: "7.8 性能调优与基线",
link: "/zh/volume6/performance.html",
},
{
text: "7.9 安全加固清单",
link: "/zh/volume6/security-hardening.html",
},
{ text: "7.10 备份与恢复", link: "/zh/volume6/backup.html" },
{ text: "7.11 版本升级与回滚", link: "/zh/volume6/upgrade.html" },
{
text: "7.12 故障排查手册",
link: "/zh/volume6/troubleshooting.html",
},
],
},
// ================================================================
// 第 8 章:规范标准(加标签/分组)
// ================================================================
{
text: "📋 8. 规范标准",
collapsed: false,
items: [
// ⭐ 必须遵守
{
text: "⭐ 必须遵守",
collapsed: false,
items: [
{
text: "8.1 API 响应规范",
link: "/zh/volume7/api-response.html",
},
{
text: "8.2 分页查询规范",
link: "/zh/volume7/pagination.html",
},
{ text: "8.3 Git 提交规范", link: "/zh/volume7/git.html" },
],
},
// 📌 建议遵守
{
text: "📌 建议遵守",
collapsed: false,
items: [
{ text: "8.4 数据删除规范", link: "/zh/volume7/deletion.html" },
{
text: "8.5 Repository 层规范",
link: "/zh/volume7/repository.html",
},
{
text: "8.6 Service 层规范",
link: "/zh/volume7/service.html",
},
{
text: "8.7 Endpoint 层规范",
link: "/zh/volume7/endpoint.html",
},
{
text: "8.8 Pydantic Schema 规范",
link: "/zh/volume7/pydantic.html",
},
{
text: "8.9 前端组件规范",
link: "/zh/volume7/fe-component.html",
},
{
text: "8.10 前端 API 模块规范",
link: "/zh/volume7/fe-api.html",
},
],
},
// 📖 参考即可
{
text: "📖 参考即可",
collapsed: false,
items: [
{ text: "8.11 测试规范", link: "/zh/volume7/testing.html" },
{
text: "8.12 代码审查清单",
link: "/zh/volume7/code-review.html",
},
{
text: "8.13 文档规范",
link: "/zh/volume7/doc-standard.html",
},
],
},
],
},
// ============================================
// 其他
// ============================================
{
text: "📄 9. 其他",
collapsed: false,
items: [
{ text: "9.1 常见问题汇总", link: "/zh/faq.html" },
{ text: "9.2 免责声明", link: "/zh/other/declare.html" },
{
text: "9.3 开源协议",
link: "https://gitee.com/djangoadmin/DjangoAdmin_Fastapi_EleVue/blob/master/LICENSE",
},
{ text: "9.4 广告赞助", link: "/zh/other/sponsor.html" },
],
},
],
},
},
};
export const zhSearch: DefaultTheme.AlgoliaSearchOptions["locales"] = {
zh: {
placeholder: "搜索文档",
translations: {
button: {
buttonText: "搜索文档",
buttonAriaLabel: "搜索文档",
},
modal: {
searchBox: {
resetButtonTitle: "清除查询条件",
resetButtonAriaLabel: "清除查询条件",
cancelButtonText: "取消",
cancelButtonAriaLabel: "取消",
},
startScreen: {
recentSearchesTitle: "搜索历史",
noRecentSearchesText: "没有搜索历史",
saveRecentSearchButtonTitle: "保存至搜索历史",
removeRecentSearchButtonTitle: "从搜索历史中移除",
favoriteSearchesTitle: "收藏",
removeFavoriteSearchButtonTitle: "从收藏中移除",
},
errorScreen: {
titleText: "无法获取结果",
helpText: "你可能需要检查你的网络连接",
},
footer: {
selectText: "选择",
navigateText: "切换",
closeText: "关闭",
searchByText: "搜索供应商",
},
noResultsScreen: {
noResultsText: "无法找到相关结果",
suggestedQueryText: "你可以尝试查询",
reportMissingResultsText: "你认为该查询应该有结果?",
reportMissingResultsLinkText: "点击反馈",
},
},
},
},
};