Skip to content

20 开发文档(总览)

本分类面向二次开发者 / 维护者 / 对接方,从整体到细节梳理可得财务(KeDe Finance)的代码结构、接口契约、运维与排错。基础使用请先看 01 项目概览02 快速开始

本分类包含

文档用途
目录架构文档代码分层、应用划分、关键服务与数据表全景
子用户后期开发文档子用户/子账户体系的设计规格(规划中功能)
全站开发文档从环境到上线的完整开发约定与协作规范
产品接口文档前台/会员/开放 API 全量接口清单与示例
管理员操作文档后台各模块操作说明与权限对照
更新产品开发文档热更新机制、版本号约定、发布与回滚流程
错误码大全统一返回结构与全部业务/HTTP 错误码

技术栈速览

技术
后端PHP 8.1+(已验证 8.5)、ThinkPHP 8 多应用
数据库MySQL 8 / MariaDB,表前缀 kd_,可选 Redis 缓存
后台前端Vue 3 + TS + Vite + Arco Design(按需引入)
前台前端Vue 3 + TS + Vite + Arco Design(按需引入)
鉴权JWT(firebase/php-jwt,HS256)
邮件PHPMailer(SMTP 驱动)

多应用与路由

ThinkPHP 按 URL 第一段分应用,约定式路由 /{app}/{控制器}/{动作}

前缀应用用途
/admin/*admin管理后台 API
/home/*home会员中心 / 前台 API
/api/*api支付回调 + 开放 API(上下游)
/setup/*setup安装向导

本地启动务必用 php -S 127.0.0.1:8800 public/router.php(或 scripts/dev-all.sh),不要用 php think run,详见 02 快速开始 常见问题。

统一返回结构

所有接口走 app\common\ApiResponse trait,返回固定 JSON:

json
{ "status": 200, "msg": "ok", "data": {} }

status 沿用 HTTP 语义(200 成功、4xx 业务/鉴权失败、5xx 服务端/上游错误)。完整码表见 错误码大全


下一篇:21 目录架构文档

KeDe Finance · 纯 PHP 自研财务系统