7.3 KiB

Raw Permalink Blame History

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

{
    "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 优惠券