Skip to content

开发规范

API 支持说明

服务端 API

平台提供完整的 RESTful API:

  • 用户认证 API
  • 数据操作 API
  • 流程引擎 API
  • 表单服务 API

客户端 API

前端提供 SDK 封装:

javascript
import { PowerMJ } from '@powermj/sdk';

const client = new PowerMJ({
  baseURL: 'http://api.example.com',
  token: 'user_token'
});

// 获取数据列表
const result = await client.data.query('leave_application', {
  page: 1,
  size: 20
});

版本管理规范

代码分支管理

  • main:主分支,生产环境代码
  • develop:开发分支,集成测试
  • feature/*:功能分支,开发新功能
  • hotfix/*:紧急修复分支

版本号规则

采用语义化版本号:主版本号.次版本号.修订号

二开代码规范

代码位置

二开代码必须写在 biz 层,不得修改平台核心代码:

├── src/
│   ├── framework/      # 平台核心代码(禁止修改)
│   └── biz/            # 业务代码(二开区域)
│       ├── controller/  # 业务控制器
│       ├── service/     # 业务服务
│       └── repository/  # 数据访问

避免平台升级冲突

  • 不修改 framework 目录下的任何文件
  • 使用平台提供的扩展点进行定制
  • 通过配置而非硬编码实现个性化

PowerMJ 普华效能生产工具