diff --git a/API.md b/API.md index aec298e00..0730d2fcc 100644 --- a/API.md +++ b/API.md @@ -771,7 +771,43 @@ View API token in Settings - About, request header: `Authorization: T ### Render a template -/template/render +/api/template/render + +## File + +### Get file + +* `/api/file/getFile` +* Parameters + + ``json + { + "path": "/data/20210808180117-6v0mkxr/20200923234011-ieuun1p.sy" + } + `` + * `path`: the file path under the workspace path +* Return value + + File content + +### Put file + +* `/api/file/putFile` +* The parameter is an HTTP Multipart form + + * `path`: the file path under the workspace path + * `isDir`: whether to create a folder, when `true` only create a folder, ignore `file` + * `modTime`: last access and modification time, Unix time + * `file`: the uploaded file +* return value + + ```json + { + "code": 0, + "msg": "", + "data": null + } + ``` ## Export diff --git a/API_zh_CN.md b/API_zh_CN.md index 4f6a8d3f2..89f36e1f3 100644 --- a/API_zh_CN.md +++ b/API_zh_CN.md @@ -774,7 +774,7 @@ ### 渲染模板 -/template/render +/api/template/render ## 文件 @@ -800,7 +800,7 @@ * `path`:工作空间路径下的文件路径 * `isDir`:是否为创建文件夹,为 `true` 时仅创建文件夹,忽略 `file` - * `modTime`:最近访问时间,Unix time + * `modTime`:最近访问和修改时间,Unix time * `file`:上传的文件 * 返回值