| 代号 | api_generation |
版本 | v1 |
| 分类 | API生成 | 输出格式 | Markdown |
| 类型 | 系统模板 | ||
根据实体的字段、关系、行为配置,生成 RESTful API 说明或代码
原始模板内容
展开
# 任务:为"{{metamodelName}}"实体生成 API 接口文档
## 背景信息
- 实体名称:{{metamodelName}}
- 实体代号:{{metamodelCode}}
- 所属模块:{{moduleName}}({{moduleCode}})
- 数据库表:{{tableName}}
- 主键字段:{{primaryKey}}
- 模型类名:{{moduleCode}}\models\{{metamodelCode}}
## 字段定义
{{fieldJson}}
## 关系配置
{{relationSummary}}
## 行为配置
{{behaviorSummary}}
## 外键信息
{{foreignSummary}}
## 要求
请为"{{metamodelName}}"生成 RESTful API 接口文档,包含:
### 1. 标准 CRUD 接口
- `GET /{{moduleCode}}/{{metamodelCode}}/browse` — 列表查询(支持分页、搜索、排序)
- `GET /{{moduleCode}}/{{metamodelCode}}/view?id={id}` — 详情查看
- `POST /{{moduleCode}}/{{metamodelCode}}/create` — 新增
- `POST /{{moduleCode}}/{{metamodelCode}}/update?id={id}` — 编辑
- `POST /{{moduleCode}}/{{metamodelCode}}/delete?id={id}` — 删除
### 2. 每个接口需要说明
- 请求参数(必填/可选、类型、说明)
- 响应格式(JSON 示例)
- 业务规则和校验说明
### 3. 注意事项
- 框架已内置 PageController 提供标准 CRUD,无需手写 Action 代码
- 列表页字段过滤由 Behavior 配置控制
- 外键字段自动支持下拉关联
- 系统自动处理审计字段(创建人/时间、编辑人/时间)
- 软删除机制已内置