API列表
大约 3 分钟
API列表
以下接口地址请根据实际情况替换服务器地址。
其中Docer公共云服务地址为：
文档库
创建模板
创建模板记录。生成文档需要模板记录
- 类型：
api - 地址：
/document - 请求方式：
post - 参数
{
name, // 名称
type // 类型：table, doc
}
- 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
data: "07efb7ed-eebc-4edf-af60-e05be90ce54c"
}
编辑模板
修改模板的基本信息。
- 类型：
api - 地址：
/document/:id - 请求方式：
put - 参数
{
name, // 名称
type // 类型：table, doc
}
- 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
}
设计模板
提供对模板的在线编辑器
- 类型：
web - 地址：
/doc/design/:id
预览模板
根据模板数据源的默认参数，生成文档内容，以预览最终文档内容效果
- 类型：
web - 地址：
/doc/preview/:id
特别说明
如果模板定义了环境变量，可通过在该地址后形如?key=value拼接环境变量，可动态修改参数信息，以达到预览不同内容的效果
删除模板
删除模板记录
- 类型：
api - 地址：
/document/:id - 请求方式：
delete - 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
}
查询模板列表
- 类型：
api - 地址：
/document/page - 请求方式：
post - 参数
{
name, // 名称
type // 类型：table, doc
}
- 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
data: [{id:"07efb7ed-eebc-4edf-af60-e05be90ce54c", name:"监测预警报告", type:"doc"}]
}
创建文档
利用某个模板，创建一个文档实例记录，并返回文档id。
- 类型：
api - 地址：
/document/record/generate?from=:id - 请求方式：
post - 参数
{
name, // 名称
env // 环境变量，json对象，覆盖模板的环境变量，如果没传则默认模板的变量
}
- 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
data: "" // 文档 did
在线编辑文档
访问文档内容，首次访问会进行内容生成，之后访问不再会调用数据集重新生成内容，所以用户可进行编辑保存。
- 类型：
web - 地址：
/doc/record/edit/:did
特别说明
如果模板定义了环境变量，可通过在该地址后形如?key=value拼接环境变量，可动态修改参数信息，以达到预览不同内容的效果
下载文档
下载文档的原始文件，支持下载docx,pdf两种格式
类型：
api地址：
/record/:did/download?type=docx请求参数：
type文档类型docx：docx格式，如果没传默认docxpdf：pdf格式
响应
文件流
预览文档
根据文档数据源的默认参数，生成文档内容，以预览最终文档内容效果
- 请求方式：
get - 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
}
删除文档
删除模板记录
- 类型：
api - 地址：
/document/record/:did - 请求方式：
delete - 响应
{
code: 200, // 200正常，其他异常
message: "", // 错误描述
}
组件库
暂不提供，请到Docer控制台进行管理
数据集
暂不提供，请到Docer控制台进行管理