Files
dacli/doc/api.md
T

341 lines
6.8 KiB
Markdown

# api.md — 完整 API 文档
> **位置**: `$ccWorkDir/dacli/doc/api.md`
> **目标**: 5 父命令 + 27 子命令的完整 API 参考
## 1. 顶层命令 (5)
| 命令 | 子命令数 | 用途 |
|------|----------|------|
| `dacli form` | 10 | 表单 CRUD |
| `dacli menu` | 4 | 菜单 CRUD |
| `dacli dm` | 5 | 数据模型 |
| `dacli dict` | 4 | 字典 |
| `dacli workflow` | 4 | 工作流 |
| `dacli doc` | 5 | HTML 文档缓存 |
| `dacli apis` | 5 | OpenAPI 查询 |
| **总计** | **37** | **+ 顶层 login/status/switch-app 等 5 工具命令** |
## 2. form (10 子命令)
### 2.1 `form list`
```
dacli form list [--appCode=X] [--pageSize=N] [--keyword=Y]
```
**返回**: `{code, msg, data: {list: [...], pagination: {...}}}`
### 2.2 `form info <id>`
```
dacli form info <id> [--appCode=X]
```
**返回**: 完整 formData/columnData/tables/flowTemplateJson
### 2.3 `form create`
```
dacli form create
--fullName=<string> # 必填
--enCode=<string> # 必填, ^[a-z0-9][a-z0-9.]*$
--type=<1|2|3|4> # 必填
--webType=<1|2|3> # 必填
--dbLinkId=<string> # 必填
--category=<string> # 必填
--fields=<json-array> # type≠4 必填
[--description=<string>]
[--autoTable] # type=1 自动建表
[--autoRelease] # 自动发布
```
**type 说明**:
- 1 = 自定义表单 (需物理表)
- 2 = 系统表单
- 3 = 数据接口表单
- 4 = 视图 (无需物理表, 无需 --fields)
**返回**: `{code, msg, data: {id, enCode, fullName}}`
### 2.4 `form release <id>`
```
dacli form release <id> [--appCode=X]
```
发布 (state 0→1)。**type=4 视图跳过, 会 400**。
### 2.5 `form delete <id>`
```
dacli form delete <id>
```
**慎用**。删除会丢失数据。
### 2.6 `form export <id>`
```
dacli form export <id> --out=<file>
```
导出完整 form JSON (含 formData/columnData/tables/...)。
### 2.7 `form import <file>`
```
dacli form import <file>
--enCode=<string> # 必填
[--fullName=<string>]
[--appCode=X]
```
### 2.8 `form clone <id>`
```
dacli form clone <id> --newEnCode=<string>
```
底层 export → import。**比手工 export+import 简单**。
### 2.9 `form validate <id>`
```
dacli form validate <id> [--fix]
```
校验 L1 必填字段 + JSON 解析完整性。返回 errors[]。
### 2.10 `form fix <id>`
```
dacli form fix <id>
```
修复老 form 缺 `__config__` 的问题。
## 3. menu (4 子命令)
### 3.1 `menu list`
```
dacli menu list [--appCode=X]
```
### 3.2 `menu create`
```
dacli menu create
--fullName=<string> # 必填
--enCode=<string> # 必填
--type=<1|2|3|4|5|6|7|8|9|10> # 必填
--category=<Web|App> # 必填
[--parentId=<id>] # 顶级 '0'
[--linkTarget=<_self|_blank>]
[--moduleId=<form-id>] # type=3 必填
[--urlAddress=<path>] # type=3 必填 'model/{enCode}'
[--webType=<1|2|3>] # type=3 必填
[--icon=<icon-class>]
[--isButtonAuthorize=<0|1>]
[--isColumnAuthorize=<0|1>]
[--isFormAuthorize=<0|1>]
[--isDataAuthorize=<0|1>]
[--description=<string>]
```
### 3.3 `menu update <id>`
```
dacli menu update <id> [--fixDisplay=true]
```
### 3.4 `menu delete <id>`
```
dacli menu delete <id>
```
## 4. dm (5 子命令)
### 4.1 `dm list`
```
dacli dm list [--appCode=X]
```
### 4.2 `dm table <table>`
```
dacli dm table <table> [--appCode=X]
```
返回表结构 + 字段定义。
### 4.3 `dm create`
```
dacli dm create
--table=<string> # 必填, snake_case 无前缀
--tableName=<string> # 必填, 中文名
--dbLinkId=<string> # 必填
--fields=<json-array> # 必填
```
**自动加** 9 系统列: f_id, f_tenant_id, f_flow_task_id, f_flow_id, f_flow_state, f_sort_code, f_create_user, f_create_time, f_modify_user, f_modify_time, f_description
### 4.4 `dm update <table>`
```
dacli dm update <table>
[--addField=<json>]
[--modifyField=<json>]
[--dropField=<field>]
```
### 4.5 `dm drop <table>`
```
dacli dm drop <table> # 慎用
```
## 5. dict (4 子命令)
### 5.1 `dict type-list`
```
dacli dict type-list [--appCode=X]
```
### 5.2 `dict type-create`
```
dacli dict type-create
--fullName=<string> # 必填
--enCode=<string> # 必填
--type=<tree|flat> # 必填
```
### 5.3 `dict data-list`
```
dacli dict data-list --dictionaryTypeId=<id>
```
### 5.4 `dict data-create`
```
dacli dict data-create
--dictionaryTypeId=<id> # 必填
--fullName=<string> # 必填
--enCode=<string> # 必填
[--parentId=<id>] # 树形可空
```
## 6. workflow (4 子命令)
### 6.1 `workflow list`
```
dacli workflow list [--appCode=X]
```
### 6.2 `workflow create`
```
dacli workflow create
--fullName=<string> # 必填
--enCode=<string> # 必填
--formType=<1|2|3|4> # 必填
--formId=<string> # 必填
--category=<dict-id> # 必填
[--description=<string>]
```
### 6.3 `workflow launch <flowId>`
```
dacli workflow launch <flowId>
--formData=<json> # 必填
```
### 6.4 `workflow approve <taskId>`
```
dacli workflow approve <taskId> --opinion=<agree|reject> [--comment=<text>]
dacli workflow reject <taskId> --opinion=<text>
```
## 7. 工具命令
### 7.1 `login`
```
dacli app login --account=<user> --password=<pass> --appCode=<app>
```
### 7.2 `status`
```
dacli app status
```
### 7.3 `switch-app`
```
dacli app switch --appCode=<app>
```
### 7.4 `logs`
```
dacli tool logs [--level=error] [--lines=50]
```
### 7.5 `initapp`
```
dacli app init --appCode=<app> --appName=<name> [--dbName=<db>] [--restart]
```
## 8. 文档/API 命令 (镜像 Java 版)
### 8.1 `doc` (5 子命令)
```
dacli doc list --dir=<path>
dacli doc get --file=<file> [--section=<name>] [--from=<N>] [--lines=<N>]
dacli doc scan --dir=<path>
dacli doc refresh --dir=<path>
dacli doc clear --file=<file>
```
### 8.2 `apis` (5 子命令)
```
dacli apis list [--tag=<tag>] [--method=<METHOD>] [--keyword=<kw>]
dacli apis info "<METHOD> <path>"
dacli apis search "<keyword>"
dacli apis refresh
dacli apis status
```
## 9. AI 增强 flags (每个命令通用)
| Flag | 行为 |
|------|------|
| `--help` | 基础帮助 (Commander.js 自动) |
| `--ai-help` | 输出 markdown 块, 可喂给 LLM |
| `--example` | 输出 JSON 示例 |
| `--source` | 指向 web 源文件 |
| `--json-schema` | 输出 JSON Schema 描述 |
## 10. 反向链接
- [architecture.md](architecture.md) — 设计
- [plan.md](plan.md) — 6 周路线
- [baseline.md](baseline.md) — 0 差错
- [extractors.md](extractors.md) — 提取工具
- [help-system.md](help-system.md) — 帮助体系
- [../.claude/skills/dacli-ts/references/commands.md](../.claude/skills/dacli-ts/references/commands.md) — AI 命令速查