# Discuz！X插件开发Skill（面向AI版）

**Repository Path**: poisonkid/discuzxdev.skill

## Basic Information

- **Project Name**: Discuz！X插件开发Skill（面向AI版）
- **Description**: 面向AI编程的Discuz! X 插件开发文档，整合官方Discuz! X3和Discuz! X5版。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 2
- **Created**: 2026-05-11
- **Last Updated**: 2026-05-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Discuz! X 插件开发文档 & AI Skill

面向开发者和 AI Agent 的 Discuz! X 插件开发参考资料，涵盖传统插件开发、RESTful API 开发和前端集成。

---

## 文件说明

### 1. 传统插件开发

| 文件 | 格式 | 说明 |
|------|------|------|
| `discuzx_plugin_dev_skill.md` | Markdown | 完整的插件开发文档，合并 X3/X5 双版本，按开发流程组织，标注版本差异 |
| `discuzx_plugin_dev_skill.json` | JSON | 结构化的 AI Skill 文件，可直接导入 AI Agent 作为系统提示 |

### 2. RESTful API 开发

| 文件 | 格式 | 说明 |
|------|------|------|
| `discuzx_restful_api_skill.md` | Markdown | RESTful API 完整文档，涵盖 XML 接口开发、过滤插件、前端 SDK 集成 |
| `discuzx_restful_api_skill.json` | JSON | RESTful API 的 AI Skill 文件，包含接口定义规范和调用示例 |

### 3. RESTful API 开发

| 文件 | 格式 | 说明 |
|------|------|------|
| `docslink.md` | Markdown | Discuz! 插件开发文档链接汇总 |

---

## 适用版本

### 传统插件开发

| 版本 | 支持情况 |
|-----|---------|
| Discuz! X3.0 ~ X3.5 | ✅ 完整支持 |
| Discuz! X5.0+ | ✅ 完整支持 |

> X5.0 不再兼容 X3.5 及更老版本，文档中已标注差异。

### RESTful API 开发

| 版本 | 支持情况 |
|-----|---------|
| Discuz!ᵂ | ✅ 完整支持 |
| Discuz! 企飞版 | ✅ 完整支持 |
| Discuz! X5 | ✅ 完整支持 |
| Discuz! X3.x | ❌ 不支持 |

---

## 文档内容概览

### 传统插件开发文档

1. **开发前准备** — 开发者模式、目录规范、版本兼容性
2. **插件基础结构** — 全局变量 `$_G`、核心常量、X5 目录结构变化
3. **插件模块类型** — 程序链接、扩展项目、页面嵌入、特殊主题、X5 子文件接管
4. **参数配置与读取** — 变量类型（含 X5 增强型）、自定义设置项组件、JSON 配置
5. **页面嵌入开发** — 嵌入点类格式、预定义函数、自定义函数、返回值规范
6. **特殊主题开发** — 主题类生命周期方法
7. **第三方扩展类** — 广告、道具、任务、验证码、验证问答
8. **其他模块** — 计划任务、缓存更新、DIY 模块、日志、Widget、支付、安全验证、多媒体解析
9. **模板与语言包** — 模板语法、细胞模板（X5）、多语言/i18n、JS 语言包
10. **安装与升级脚本** — 安装/卸载/升级/检测/开启关闭脚本
11. **X5 新特性总览** — MitFrame 架构、新增组件、模板增强
12. **开发注意事项** — 安全规范、数据规范、兼容性规范

### RESTful API 开发文档

1. **概述** — oAuth2 协议、声明式开发、签名认证、Token 机制
2. **准备工作** — 创建应用、获取 appid/secret、导入接口
3. **XML 接口开发** — 完整结构、path/URL 映射、输出变量映射、参数格式、属性配置
4. **过滤插件开发** — before/after 插件、类结构、参数处理
5. **接口调用规范** — 签名算法（PHP/JS）、Token 获取、validateData/validateUnique
6. **前端开发集成** — JavaScript/TypeScript SDK、Vue/React 集成、Token 管理
7. **开发调试** — 开发者模式、Redis 前缀、Apipost 在线调试
8. **更新源与分发** — XML 导入、更新源配置
9. **注意事项** — 请求方式、编码规范、版本管理

---

## 使用场景

### 场景一：开发传统 Discuz! 插件

使用 `discuzx_plugin_dev_skill.json` 作为 AI 助手知识库，快速生成：

- 页面嵌入类代码
- 特殊主题类代码
- 第三方扩展类（广告/道具/任务）
- 安装/卸载/升级脚本
- X5 新特性模块（Widget、支付、安全验证等）

### 场景二：开发 RESTful API 接口

使用 `discuzx_restful_api_skill.json` 作为 AI 助手知识库，快速生成：

- XML 接口定义文件
- 过滤插件代码（before/after）
- PHP 请求封装类
- JavaScript/TypeScript SDK

### 场景三：前端集成 Discuz! API

参考 RESTful API 文档，实现：

- 获取 Token 和签名计算
- 调用业务接口（版块列表、帖子内容、用户登录等）
- 在 Vue/React 项目中集成

---

## JSON Skill 文件结构

### discuzx_plugin_dev_skill.json

```
├── name / version / description     基本信息
├── compatibility                     版本兼容性（X3/X5）
├── instructions                      核心开发指令
│   ├── development_workflow          6 步开发流程
│   ├── core_concepts                 全局变量、常量、数据库
│   ├── module_development            页面嵌入、特殊主题
│   ├── extension_classes             广告/道具/任务/验证码等
│   ├── x5_new_features               X5 新增模块和特性
│   ├── template_syntax               模板语法速查
│   ├── security_rules                安全规则
│   └── version_differences           X3 vs X5 差异对比
├── examples                          代码示例
├── quick_reference                   快速参考
└── metadata                          元数据
```

### discuzx_restful_api_skill.json

```
├── name / version / description     基本信息
├── compatibility                     适用平台（Discuz!ᵂ/X5/企飞版）
├── instructions                      核心开发指令
│   ├── architecture                  请求流程架构
│   ├── xml_development               XML 接口开发规范
│   ├── filter_plugin                 过滤插件开发
│   ├── api_calling                   接口调用规范
│   ├── frontend_integration          前端集成
│   ├── development                   开发调试
│   ├── distribution                  更新源与分发
│   └── rules                         开发规则
├── examples                          代码示例（XML/PHP/JS）
├── quick_reference                   快速参考
└── metadata                          元数据
```

---

## 参考来源

- [Discuz! 官方开发文档](https://open.dismall.com/?ac=document&page=dev)
- [Discuz! X5 开发范例](https://gitee.com/Discuz/DiscuzXDevSample)
- [Discuz! X5 RESTful API 仓库](https://gitee.com/Discuz/discuz-restful-api)
- [Discuz! X5 RESTful API 在线文档](https://docs.apipost.net/docs/detail/2c7d89151864000)
- [UCenter 2.0 RESTful SDK](https://gitee.com/Discuz/UCenter/tree/master/developer)

---

## 许可证

MIT