关键要点
此模板为您提供带有文档、版本和协作功能的文档维基后端,使您的团队可以专注于内容管理和用户互动。
- 以文档为中心的架构设计 — 使用版本和协作编辑在清晰、可查询的结构中建模文档。
- 实时协作 — 使用Back4app的实时功能进行协作编辑和更新。
- 版本管理 — 通过历史记录和更改通知管理文档版本。
- 富文本编辑功能 — 允许用户无缝创建、编辑和协作处理文档。
- 跨平台文档后端 — 通过单一的REST和GraphQL API为移动和网络客户端提供文档、版本和协作服务。
什么是文档Wiki应用后端模板?
Back4app是一个后端即服务(BaaS),用于快速产品交付。文档Wiki应用后端模板是一个预构建的模式,包括文档、版本和协作。连接您喜欢的前端(React、Flutter、Next.js等),更快交付。
最佳适用:
概述
一个文档维基产品需要文档管理、版本控制和协作能力。
此模板定义了文档、版本和协作,具有实时功能和所有权规则,以便团队可以快速实现知识库交互。
核心文档 Wiki 功能
此中心的每个技术卡都使用相同的文档维基后端架构,包括文档、版本和协作。
文档管理和版本
文档类存储标题、内容、作者和版本。
版本控制和历史
版本类链接文档、变更和时间戳。
协作编辑
协作类存储文档引用、用户和角色。
为什么使用Back4app构建您的文档 Wiki 后端?
Back4app为您提供文档、版本和协作原语,因此您的团队可以专注于内容管理和用户互动,而不是基础设施。
- •文档和版本管理: 具有标题、内容和版本跟踪的文档类支持知识库交互。
- •协作和编辑功能: 通过角色管理协作编辑,并允许用户轻松编辑文档。
- •实时 + API 灵活性: 使用Live Queries进行协作更新,同时保持 REST 和 GraphQL 可用于每个客户端。
在所有平台上使用一个后端合同快速构建和迭代文档功能。
核心优势
一个帮助您快速迭代而不牺牲结构的文档后端。
快速文档启动
从完整的文档、版本和协作架构开始,而不是从零设计后端。
实时协作支持
利用实时编辑和更新以增强用户互动。
清除版本控制流程
使用历史记录和更改通知管理文档版本。
可扩展的权限模型
使用ACL/CLP,以便只有授权用户可以编辑文档和管理版本。
协作编辑数据
存储和汇总协作数据以进行显示和交互,而无需重置模式。
AI引导工作流程
通过一个结构化提示快速生成后端脚手架和集成指导。
准备好启动您的文档维基应用程序了吗?
让Back4app AI 代理为您搭建文档风格的后端,并从一个提示生成文档、版本和协作。
免费开始 — 每月50次 AI 代理提示,无需信用卡
技术栈
此文档维基后端模板中包含的一切。
ER 图
文档维基后端模式的实体关系模型。
涵盖文档、版本和协作的模式。
查看图源
erDiagram
User ||--o{ Document : "author"
User ||--o{ Comment : "author"
Document ||--o{ Version : "document"
Document ||--o{ Comment : "document"
Document ||--o{ Collaboration : "document"
User ||--o{ Collaboration : "user"
User {
String objectId PK
String username
String email
String password
String profilePicture
String bio
Date createdAt
Date updatedAt
}
Document {
String objectId PK
String title
String content
Pointer author FK
Date createdAt
Date updatedAt
}
Version {
String objectId PK
Pointer document FK
Number versionNumber
String content
Date createdAt
}
Comment {
String objectId PK
Pointer document FK
Pointer author FK
String content
Date createdAt
}
Collaboration {
String objectId PK
Pointer document FK
Pointer user FK
String role
Date createdAt
}
集成流程
身份验证、文档、版本和协作的典型运行时流程。
查看图源
sequenceDiagram
participant User
participant App as Documentation Wiki App
participant Back4app as Back4app Cloud
User->>App: Login
App->>Back4app: POST /login
Back4app-->>App: Session token
User->>App: View documents
App->>Back4app: GET /classes/Document
Back4app-->>App: Documents list
User->>App: Edit document
App->>Back4app: PUT /classes/Document/{objectId}
Back4app-->>App: Updated document
User->>App: Add comment
App->>Back4app: POST /classes/Comment
Back4app-->>App: Comment objectId
Back4app-->>App: Live Queries (optional)
App-->>User: Real-time updates on document changes数据字典
文档维基模式中每个类的完整字段级参考。
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| objectId | String | Auto-generated unique identifier | 自动 |
| username | String | User login name | |
| String | User email address | ||
| password | String | Hashed password (write-only) | |
| profilePicture | String | URL of the user's profile picture | — |
| bio | String | Short biography of the user | — |
| createdAt | Date | Auto-generated creation timestamp | 自动 |
| updatedAt | Date | Auto-generated last-update timestamp | 自动 |
User中的8字段
安全性和权限
ACL和CLP策略如何保护文档、版本和协作。
用户拥有的文档控制
只有授权用户可以更新或删除文档;其他人无法修改内容。
版本和协作完整性
只有作者或合作者可以创建或删除版本和协作。使用Cloud Code进行验证。
范围读取访问
将文档和版本的读取限制为相关方(例如,用户只能看到自己的文档和公共版本)。
模式(JSON)
原始JSON模式定义,准备复制到Back4app或用作实现参考。
{
"classes": [
{
"className": "User",
"fields": {
"objectId": {
"type": "String",
"required": false
},
"username": {
"type": "String",
"required": true
},
"email": {
"type": "String",
"required": true
},
"password": {
"type": "String",
"required": true
},
"profilePicture": {
"type": "String",
"required": false
},
"bio": {
"type": "String",
"required": false
},
"createdAt": {
"type": "Date",
"required": false
},
"updatedAt": {
"type": "Date",
"required": false
}
}
},
{
"className": "Document",
"fields": {
"objectId": {
"type": "String",
"required": false
},
"title": {
"type": "String",
"required": true
},
"content": {
"type": "String",
"required": true
},
"author": {
"type": "Pointer",
"required": true,
"targetClass": "User"
},
"createdAt": {
"type": "Date",
"required": false
},
"updatedAt": {
"type": "Date",
"required": false
}
}
},
{
"className": "Version",
"fields": {
"objectId": {
"type": "String",
"required": false
},
"document": {
"type": "Pointer",
"required": true,
"targetClass": "Document"
},
"versionNumber": {
"type": "Number",
"required": true
},
"content": {
"type": "String",
"required": true
},
"createdAt": {
"type": "Date",
"required": false
}
}
},
{
"className": "Comment",
"fields": {
"objectId": {
"type": "String",
"required": false
},
"document": {
"type": "Pointer",
"required": true,
"targetClass": "Document"
},
"author": {
"type": "Pointer",
"required": true,
"targetClass": "User"
},
"content": {
"type": "String",
"required": true
},
"createdAt": {
"type": "Date",
"required": false
}
}
},
{
"className": "Collaboration",
"fields": {
"objectId": {
"type": "String",
"required": false
},
"document": {
"type": "Pointer",
"required": true,
"targetClass": "Document"
},
"user": {
"type": "Pointer",
"required": true,
"targetClass": "User"
},
"role": {
"type": "String",
"required": true
},
"createdAt": {
"type": "Date",
"required": false
}
}
}
]
}使用 AI 代理构建
使用 Back4app AI 代理从此模板生成一个真实的文档维基应用,包括前端、后端、认证、文档、版本和协作流程。
在 Back4app 上使用此精确模式和行为创建一个文档风格的知识库应用后端。 模式: 1. 文档:标题(字符串,必需),内容(字符串,必需),作者(指向用户的指针,必需);objectId, createdAt, updatedAt(系统)。 2. 版本:文档(指向文档的指针,必需),更改(字符串,必需),时间戳(日期,必需);objectId, createdAt, updatedAt(系统)。 3. 协作:文档(指向文档的指针,必需),用户(指向用户的指针,必需),角色(字符串:编辑者,查看者,必需);objectId, createdAt, updatedAt(系统)。 安全: - 只有授权用户可以更新/删除文档。只有协作者可以创建/删除版本。使用云代码进行验证。 认证: - 注册、登录、注销。 行为: - 列出文档,创建版本,协作编辑文档,管理角色。 交付: - Back4app 应用,包含模式、ACLs、CLPs;用于文档管理、版本控制和协作的前端。
按下面的按钮打开代理,预填此模板提示。
这是没有技术后缀的基本提示。您可以在之后调整生成的前端堆栈。
API 操作台
根据文档维基架构尝试 REST 和 GraphQL 端点。响应使用模拟数据,不需要 Back4app 账户。
使用与此模板相同的架构。
选择您的技术
展开每张卡片以查看集成步骤、状态模式、数据模型示例和离线说明。
Flutter 文档 Wiki 后端
React 文档 Wiki 后端
React 原生 文档 Wiki 后端
Next.js 文档 Wiki 后端
JavaScript 文档 Wiki 后端
Android 文档 Wiki 后端
iOS 文档 Wiki 后端
Vue 文档 Wiki 后端
Angular 文档 Wiki 后端
GraphQL 文档 Wiki 后端
REST API 文档 Wiki 后端
PHP 文档 Wiki 后端
.NET 文档 Wiki 后端
每种技术都能获得什么
每个堆栈使用相同的文档维基后端架构和API合同。
统一的文档维基数据结构
一个连贯的架构用于高效管理文档和版本。
文档维基的实时协作
使多个用户能够同时编辑和评论文档。
文档维基的版本控制
无缝跟踪更改并恢复到之前的文档版本。
用于文档维基的REST/GraphQL API
使用标准化API轻松与各种前端集成。
文档维基的用户访问控制
管理权限以确保安全的文档访问和协作。
文档维基的可扩展框架
使用可定制的功能适应和扩展您的文档需求。
文档维基框架比较
比较所有支持技术的设置速度、SDK风格和AI支持。
| 框架 | 设置时间 | 文档维基优势 | SDK类型 | AI支持 |
|---|---|---|---|---|
| 少于5分钟 | 移动和网页的文档维基单一代码库。 | Typed SDK | 完整 | |
| ~3–7分钟 | 文档维基的快速网页仪表板。 | Typed SDK | 完整 | |
| 快速(5分钟)设置 | 文档维基的跨平台移动应用。 | Typed SDK | 完整 | |
| ~5分钟 | 文档维基的服务器渲染网页应用。 | Typed SDK | 完整 | |
| ~3–5分钟 | 文档维基的轻量级网页集成。 | Typed SDK | 完整 | |
| 少于5分钟 | 文档维基的本地Android应用。 | Typed SDK | 完整 | |
| ~3–7分钟 | 文档维基的本地iOS应用。 | Typed SDK | 完整 | |
| 快速(5分钟)设置 | React的文档维基网页用户界面。 | Typed SDK | 完整 | |
| ~5分钟 | 文档维基的企业网页应用。 | Typed SDK | 完整 | |
| 少于2分钟 | 灵活的GraphQL API用于文档维基。 | GraphQL API | 完整 | |
| 快速(2分钟)设置 | REST API集成用于文档维基。 | REST API | 完整 | |
| ~3分钟 | 文档维基的服务器端PHP后端。 | REST API | 完整 | |
| 快速(5分钟)设置 | .NET后端用于文档维基。 | Typed SDK | 完整 |
设置时间反映从项目启动到使用此模板架构进行首次文档查询的预期持续时间。
常见问题
关于使用此模板构建文档维基后端的常见问题。