forked from erp-dev/erp
feat: shipment patch
This commit is contained in:
105
docs/quick_create_employee_user_command.md
Normal file
105
docs/quick_create_employee_user_command.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# quick_create_employee_user 命令说明
|
||||
|
||||
这个命令是对现有 `api_v2` 快速创用户接口的命令化封装,底层复用同一套共享 service。
|
||||
|
||||
相关入口:
|
||||
|
||||
- API:`POST /api/v2/users/quick-create/`
|
||||
- Command:`python manage.py quick_create_employee_user`
|
||||
|
||||
## 共享实现
|
||||
|
||||
共享业务逻辑在:
|
||||
|
||||
- [basic_info/services.py](/home/f/coding/flower/basic_info/services.py)
|
||||
|
||||
API 和 command 都调用:
|
||||
|
||||
- `EmployeeUserProvisioningService.quick_create_employee_user(...)`
|
||||
|
||||
这样可以避免:
|
||||
|
||||
- API 与命令校验规则不一致
|
||||
- 后续 MCP server 再复制一份逻辑
|
||||
|
||||
## 参数
|
||||
|
||||
必填参数:
|
||||
|
||||
- `--username`
|
||||
- `--password`
|
||||
- `--display-name`
|
||||
- `--merchant-id`
|
||||
|
||||
可选参数:
|
||||
|
||||
- `--email`
|
||||
- `--mobile`
|
||||
- `--area`
|
||||
- `--description`
|
||||
- `--status`
|
||||
- `--role-id`
|
||||
- `--json`
|
||||
|
||||
## 示例
|
||||
|
||||
普通输出:
|
||||
|
||||
```bash
|
||||
python manage.py quick_create_employee_user \
|
||||
--username demo_user \
|
||||
--password pass123456 \
|
||||
--display-name 演示员工 \
|
||||
--merchant-id 1
|
||||
```
|
||||
|
||||
JSON 输出:
|
||||
|
||||
```bash
|
||||
python manage.py quick_create_employee_user \
|
||||
--json \
|
||||
--username demo_user \
|
||||
--password pass123456 \
|
||||
--display-name 演示员工 \
|
||||
--merchant-id 1 \
|
||||
--mobile 13800000000
|
||||
```
|
||||
|
||||
成功时输出示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"result": {
|
||||
"user": {
|
||||
"id": 127,
|
||||
"username": "demo_user",
|
||||
"display_name": "演示员工",
|
||||
"role_id": null
|
||||
},
|
||||
"employee": {
|
||||
"id": 128,
|
||||
"name": "演示员工",
|
||||
"status": "在职",
|
||||
"merchant": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
失败时如果带 `--json`,输出示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"ok": false,
|
||||
"error": "用户名已存在"
|
||||
}
|
||||
```
|
||||
|
||||
## 设计目的
|
||||
|
||||
这个命令主要是为了:
|
||||
|
||||
- 让运维/开发可以不经过 HTTP 直接创建用户
|
||||
- 给外部脚本或 MCP server 提供稳定入口
|
||||
- 保持和现有 `api_v2` 行为一致
|
||||
Reference in New Issue
Block a user