标准化接口概览

想了解平台所有模型视图共用的标准 REST 接口(_info/list/show/add/edit/delete/action/echart/favorite/上传下载)时从这里入口

06-二次开发 / API参考
标准化接口MyappModelRestApi基类CRUDREST API通用约定路径对照viewroute_base接口规范

标准化接口(基类 MyappModelRestApi 提供)

所有继承 MyappModelRestApimyapp/views/baseApi.py)的视图类自动拥有一套标准 REST 接口。路由前缀记为 $view(如 /pipeline_modelview/api),完整 URL = http://x.x.x.x/$view/ + 下列各接口路径。

各视图的 $view 路由前缀与特殊接口见 接口总览;各模型字段详情见 标准化接口参数详情

子文档目录(TOC)

文件 内容
01-通用约定与路径对照.md 请求 Header、通用响应格式、外键传参规则、$view 路径对照表
02-标准CRUD接口.md _info 元信息、list 列表查询(含过滤操作符)、showaddeditdelete
03-操作图表收藏.md action 单条操作、multi_action 批量操作、echart 图表、favorite 收藏
04-文件上传下载.md download_templateupload 批量导入、download 批量导出、upload_files 分块上传
05-Python客户端示例.md 以 pipeline/task 增删改查为例的完整 Python 调用脚本

接口一览

接口 方法 路径
元信息 _info GET /_info
列表 list GET /
单条 show GET /<id>
新增 add POST /
更新 edit PUT /<id>
删除 delete DELETE /<id>
单条操作 action GET /action/<action_name>/<id>
批量操作 multi_action POST /multi_action/<action_name>
图表 echart GET /echart
收藏 favorite POST / DELETE /favorite/<id>
下载模板 download_template GET /download_template/
批量导入 upload POST /upload/
批量导出 download GET /download/
通用分块上传 upload_files POST /upload_files/
最后更新 2026-06-30完整文档以官方仓库为准:GitHub Wiki