feat: 添加官方文档索引 + 各文档嵌入 doc 链接
- docs/OFFICIAL_DOCS.md: 完整官方文档映射表（含功能→文档映射） - 更新 00_OVERVIEW/01_SHOPXO_TECHNICAL_RESEARCH/ARCHITECTURE/README - 新增官方文档站入口：https://doc.shopxo.net/council/backend-reviewer
sileya-ai
parent
14493d9d41
commit
894a8c1fbb
|
|
@ -229,6 +229,14 @@ static/vr_ticket/ # 静态资源
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 官方文档（开发前必查）
|
||||||
|
|
||||||
|
- 官方文档站：https://doc.shopxo.net/
|
||||||
|
- 插件开发文档：https://doc.shopxo.net/article/3.html
|
||||||
|
- 开发文档索引：https://doc.shopxo.net/article/4.html
|
||||||
|
- uniapp 打包教程：https://doc.shopxo.net/article/1/293727233598554112.html
|
||||||
|
- 完整索引：[docs/OFFICIAL_DOCS.md](docs/OFFICIAL_DOCS.md)
|
||||||
|
|
||||||
## 开发文档
|
## 开发文档
|
||||||
|
|
||||||
| 文档 | 内容 |
|
| 文档 | 内容 |
|
||||||
|
|
|
||||||
11
README.md
11
README.md
|
|
@ -37,6 +37,17 @@ cp -r vr-shopxo-plugin/app/plugins/vr_ticket /path/to/shopxo/app/plugins/
|
||||||
# 发行 → 微信小程序
|
# 发行 → 微信小程序
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 官方文档（开发前必查）
|
||||||
|
|
||||||
|
| 资源 | URL |
|
||||||
|
|---|---|
|
||||||
|
| 官方文档首页 | https://doc.shopxo.net/ |
|
||||||
|
| **插件开发文档** | https://doc.shopxo.net/article/3.html |
|
||||||
|
| **开发文档索引** | https://doc.shopxo.net/article/4.html |
|
||||||
|
| uniapp 打包教程 | https://doc.shopxo.net/article/1/293727233598554112.html |
|
||||||
|
| shopxo-uniapp Gitee | https://gitee.com/zongzhige/shopxo-uniapp |
|
||||||
|
| 完整官方文档索引 | [docs/OFFICIAL_DOCS.md](docs/OFFICIAL_DOCS.md) |
|
||||||
|
|
||||||
## 技术调研文档
|
## 技术调研文档
|
||||||
|
|
||||||
- [ShopXO 技术能力调研](docs/01_SHOPXO_TECHNICAL_RESEARCH.md) — DIY/CustomView/钩子/插件完整分析
|
- [ShopXO 技术能力调研](docs/01_SHOPXO_TECHNICAL_RESEARCH.md) — DIY/CustomView/钩子/插件完整分析
|
||||||
|
|
|
||||||
|
|
@ -39,6 +39,17 @@ ShopXO 是轻量 PHP 商城系统（MIT 协议），具备：
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 官方文档（开发前必查）
|
||||||
|
|
||||||
|
| 资源 | URL |
|
||||||
|
|---|---|
|
||||||
|
| 官方文档首页 | https://doc.shopxo.net/ |
|
||||||
|
| **插件开发文档** | https://doc.shopxo.net/article/3.html |
|
||||||
|
| **开发文档索引** | https://doc.shopxo.net/article/4.html |
|
||||||
|
| uniapp 打包教程 | https://doc.shopxo.net/article/1/293727233598554112.html |
|
||||||
|
| 功能清单 | https://doc.shopxo.net/article/1/260684202096197632.html |
|
||||||
|
| 完整官方文档索引 | [docs/OFFICIAL_DOCS.md](docs/OFFICIAL_DOCS.md) |
|
||||||
|
|
||||||
## 文档目录
|
## 文档目录
|
||||||
|
|
||||||
| 文档 | 内容 |
|
| 文档 | 内容 |
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
# ShopXO 技术能力完整调研
|
# ShopXO 技术能力完整调研
|
||||||
|
|
||||||
> 调研时间：2026-04-14（上午）
|
> 调研时间：2026-04-14（上午）
|
||||||
> 调研方式：源码分析 + Council 并行 agent 调研（ShopXO / Bagisto / Saleor / Medusa）
|
> 调研方式：源码分析 + 官方文档交叉验证
|
||||||
|
> 官方文档站：https://doc.shopxo.net/（**开发前必查**）
|
||||||
> 源码位置：`council-research/shopxo-eval/.worktrees/shopxo-evaluator/shopxo-src/`
|
> 源码位置：`council-research/shopxo-eval/.worktrees/shopxo-evaluator/shopxo-src/`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,198 @@
|
||||||
|
# ShopXO 官方文档索引
|
||||||
|
|
||||||
|
> 整理时间：2026-04-14
|
||||||
|
> 官方文档站：https://doc.shopxo.net/
|
||||||
|
> 官方 GitHub：https://github.com/gongfuxiang/shopxo
|
||||||
|
> shopxo-uniapp：https://gitee.com/zongzhige/shopxo-uniapp
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 一、官方文档总入口
|
||||||
|
|
||||||
|
| 文档 | URL | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| 文档首页 | https://doc.shopxo.net/ | PESCMS DOC 框架，文档导航 |
|
||||||
|
| 开发文档索引 | https://doc.shopxo.net/article/4.html | 包含基础教程、插件开发、API接口 |
|
||||||
|
| 插件开发文档 | https://doc.shopxo.net/article/3.html | **插件开发核心文档** |
|
||||||
|
| 目录结构 | https://doc.shopxo.net/article/4/265292898306621440.html | **系统目录结构（v1-v2）** |
|
||||||
|
| 基础配置 | https://doc.shopxo.net/?a=index&aid=262830136821284864&id=4&m=Article | 动态数据表格配置语法 |
|
||||||
|
| 系统安装教程 | https://doc.shopxo.net/article/1/260667307922030592.html | 系统安装步骤 |
|
||||||
|
| 系统演示 | https://doc.shopxo.net/article/1/260674843488288768.html | 官方演示站 |
|
||||||
|
| 更新日志 | https://doc.shopxo.net/article/1/260687012997103616.html | 版本更新历史 |
|
||||||
|
| 功能清单 | https://doc.shopxo.net/article/1/260684202096197632.html | 系统全部功能列表 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 二、插件开发文档
|
||||||
|
|
||||||
|
### 2.1 核心文档
|
||||||
|
|
||||||
|
| 功能 | 官方文档 URL | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| 插件开发文档首页 | https://doc.shopxo.net/article/3.html | 创建插件、命名规则、目录结构 |
|
||||||
|
| **钩子响应** | https://doc.shopxo.net/article/3.html | 视图钩子详细说明 |
|
||||||
|
| **回调事件** | https://doc.shopxo.net/article/3.html | Service 层事件钩子 |
|
||||||
|
| URL生成 | https://doc.shopxo.net/article/3.html | 插件内 URL 生成方法 |
|
||||||
|
| 调试及开发模式 | https://doc.shopxo.net/article/3.html | 开发调试方法 |
|
||||||
|
|
||||||
|
### 2.2 开启开发者模式
|
||||||
|
|
||||||
|
**官方文档**：https://doc.shopxo.net/article/3.html
|
||||||
|
|
||||||
|
开启后可在后台直接创建插件，页面出现钩子提示名称。
|
||||||
|
|
||||||
|
> 文件位置：`config/shopxo.php`，将 `is_develop` 项的值由 `false` 改为 `true`。
|
||||||
|
|
||||||
|
### 2.3 插件目录结构
|
||||||
|
|
||||||
|
**官方文档**：https://doc.shopxo.net/article/4/265292898306621440.html
|
||||||
|
|
||||||
|
```
|
||||||
|
app/plugins/{PluginName}/
|
||||||
|
├── config.json ← 插件配置（基础信息、钩子注册）
|
||||||
|
├── BaseService.php ← 必须：配置字段 + 安装/卸载逻辑
|
||||||
|
├── view/
|
||||||
|
│ ├── Goods.php ← 商品详情页钩子实现
|
||||||
|
│ ├── User.php ← 用户中心钩子实现
|
||||||
|
│ └── ...
|
||||||
|
├── Admin/
|
||||||
|
│ ├── Controller/ ← 后台控制器
|
||||||
|
│ └── View/ ← 后台视图
|
||||||
|
└── Api/
|
||||||
|
└── Controller/ ← API 控制器
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.4 插件配置文件格式
|
||||||
|
|
||||||
|
**官方参考**：CSDN 第三方指南 https://blog.csdn.net/gitblog_00934/article/details/152009784
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"base": {
|
||||||
|
"name": "VR票务插件",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"author": "sileya-ai",
|
||||||
|
"desc": "VR演唱会票务插件"
|
||||||
|
},
|
||||||
|
"hook": {
|
||||||
|
"plugins_view_goods_detail_base_sku_top": [
|
||||||
|
"\\app\\plugins\\vr_ticket\\view\\Goods::PluginsViewGoodsDetailBaseSkuTop"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 三、uni-app 小程序开发
|
||||||
|
|
||||||
|
### 3.1 小程序打包教程
|
||||||
|
|
||||||
|
**官方文档**：https://doc.shopxo.net/article/1/293727233598554112.html
|
||||||
|
|
||||||
|
覆盖内容：
|
||||||
|
- HBuilderX 下载安装
|
||||||
|
- shopxo-uniapp 源码导入
|
||||||
|
- `App.vue` 接口地址配置（`request_url` / `static_url`）
|
||||||
|
- `manifest.json` 各端配置（AppID、权限等）
|
||||||
|
- **微信小程序发行步骤**
|
||||||
|
- 条件编译指令（`#ifdef MP-WEIXIN`）
|
||||||
|
- 主题配色修改
|
||||||
|
|
||||||
|
### 3.2 shopxo-uniapp 源码地址
|
||||||
|
|
||||||
|
| 平台 | 地址 |
|
||||||
|
|---|---|
|
||||||
|
| Gitee | https://gitee.com/zongzhige/shopxo-uniapp |
|
||||||
|
| GitHub | https://github.com/gongfuxiang/shopxo-uniapp |
|
||||||
|
| uni-app 插件市场 | https://ext.dcloud.net.cn/plugin?id=6380 |
|
||||||
|
|
||||||
|
### 3.3 HBuilderX 下载
|
||||||
|
|
||||||
|
官方地址：https://www.dcloud.io/hbuilderx.html
|
||||||
|
建议下载 **APP开发版**（已集成 uni-app 插件，开箱即用）
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 四、ThinkPHP 框架文档
|
||||||
|
|
||||||
|
ShopXO 基于 ThinkPHP 6/8 框架开发。
|
||||||
|
|
||||||
|
| 资源 | URL |
|
||||||
|
|---|---|
|
||||||
|
| ThinkPHP 6 文档 | https://www.kancloud.cn/manual/thinkphp6_0/ |
|
||||||
|
| ThinkPHP 8 文档 | https://www.kancloud.cn/manual/thinkphp8_0/ |
|
||||||
|
| 模板引擎 | https://www.kancloud.cn/manual/think-template/ |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 五、API 接口文档
|
||||||
|
|
||||||
|
**官方文档**：https://doc.shopxo.net/?a=index&aid=300808037910708224&id=2&m=Article
|
||||||
|
|
||||||
|
ShopXO 提供完整的 RESTful API，覆盖：
|
||||||
|
- 公共接口（地区、文件上传）
|
||||||
|
- 用户接口（登录、注册、积分、消息）
|
||||||
|
- 商品接口（列表、详情、规格）
|
||||||
|
- 订单接口（下单、支付、退款）
|
||||||
|
- 优惠券接口
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 六、功能模块官方参考
|
||||||
|
|
||||||
|
### 6.1 门店系统（核销相关）
|
||||||
|
|
||||||
|
ShopXO 门店功能（含核销/派单/收银）：**功能清单** https://doc.shopxo.net/article/1/260684202096197632.html
|
||||||
|
|
||||||
|
> 描述：派单+转单+**核销**+代客下单+商品+批次+次卡+员工和薪水自动抽成+充值+收银+桌码+O2O店铺运营模式
|
||||||
|
|
||||||
|
### 6.2 会员钱包/积分
|
||||||
|
|
||||||
|
**功能清单**：https://doc.shopxo.net/article/1/260684202096197632.html
|
||||||
|
|
||||||
|
### 6.3 优惠券
|
||||||
|
|
||||||
|
**功能清单**：https://doc.shopxo.net/article/1/260684202096197632.html
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 七、我们的功能 → 官方文档映射表
|
||||||
|
|
||||||
|
| 我们要开发的功能 | 对应官方文档 | URL |
|
||||||
|
|---|---|---|
|
||||||
|
| 插件骨架创建 | 插件开发文档 / 目录结构 | https://doc.shopxo.net/article/3.html |
|
||||||
|
| 钩子注册（商品页/用户中心） | 插件开发文档 - 钩子响应 | https://doc.shopxo.net/article/3.html |
|
||||||
|
| 插件 Service 层（订单事件） | 插件开发文档 - 回调事件 | https://doc.shopxo.net/article/3.html |
|
||||||
|
| 插件内 URL 生成 | 插件开发文档 - URL生成 | https://doc.shopxo.net/article/3.html |
|
||||||
|
| 插件调试 | 插件开发文档 - 调试模式 | https://doc.shopxo.net/article/3.html |
|
||||||
|
| 微信小程序编译/发行 | uniapp版打包教程 | https://doc.shopxo.net/article/1/293727233598554112.html |
|
||||||
|
| uni-app 条件编译 | uniapp版打包教程 | https://doc.shopxo.net/article/1/293727233598554112.html |
|
||||||
|
| 微信小程序 AppID 配置 | uniapp版打包教程 | https://doc.shopxo.net/article/1/293727233598554112.html |
|
||||||
|
| 虚拟商品/订单模式 | 功能清单 | https://doc.shopxo.net/article/1/260684202096197632.html |
|
||||||
|
| QR 码生成 | 基础类 `\base\Qrcode` | 源码：shopxo-src/extend/base/Qrcode.php |
|
||||||
|
| ThinkPHP 模板语法 | 模板引擎方法及变量 | https://doc.shopxo.net/article/4.html |
|
||||||
|
| 系统安装/配置 | 系统安装教程 | https://doc.shopxo.net/article/1/260667307922030592.html |
|
||||||
|
| 插件升级兼容性 | 更新日志 | https://doc.shopxo.net/article/1/260687012997103616.html |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 八、第三方参考（高质量）
|
||||||
|
|
||||||
|
| 资源 | URL | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| ShopXO 插件开发完整指南 | https://blog.csdn.net/gitblog_00934/article/details/152009784 | 从零构建插件的完整技术路线 |
|
||||||
|
| ShopXO 二次开发汇总 | https://blog.csdn.net/qq_35393869/article/details/114523844 | 官方文档汇总，含 ThinkPHP/AmazeUI 参考 |
|
||||||
|
| ShopXO 开发实战 | https://zhuanlan.zhihu.com/p/363561060 | 二次开发笔记 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 九、官方社区
|
||||||
|
|
||||||
|
| 平台 | 地址 |
|
||||||
|
|---|---|
|
||||||
|
| 官方 QQ 群 | 833531593 / 641730223（答案：shopxo.net） |
|
||||||
|
| uniapp 官方群 | 679303149 |
|
||||||
|
| GitHub | https://github.com/gongfuxiang/shopxo |
|
||||||
|
| Gitee | https://gitee.com/zongzhige/shopxo |
|
||||||
|
| 应用商店 | https://store.shopxo.net/ |
|
||||||
Loading…
Reference in New Issue