API Zdir3 API使用说明 获取认证(必看) Zdir 3部分接口,比如上传、重命名、删除等操作需要获取认证Token后才能操作,部分公共API则无需认证,获取认证方法如下。 接口说明 请求地址:/api/user/login 请求方法:POST 提交方式:multipart/form-data 请求参数 参数名称 示例值 类型 是否必须 说明 username xiaoz string(16) 是 用户名 password xiaoz.me string(16) 是 密码 请求成功响应 { "code": 200, "data": { "UserName": "xxx", "Cid": "JJjKWZ", "Token": "5de13ebfb0xxxxxx861fbe" }, "msg": "success" } code:200代表成功,其它为失败 msg:消息内容 data.UserName:返回用户名 data.Cid:返回的ClientID,后续认证需要 data.Token:返回的Token值,后续认证需要 注意:Token认证有效期为7天,过期后请重新获取。 请求失败响应 { "code": -1000, "data": "", "msg": "用户名或密码错误!" } 请求认证 需要认证的接口需要携带header头部,以下为公共头部参数: 参数名称 示例值 类型 是否必须 说明 X-Cid JJjKWZ string(6) 是 CID,对应data.Cid X-Token 5de13ebfb0xxxxxx861fbe string(32) 是 Toekn,对应data.Token 获取文件列表 接口说明 请求地址:/api/filelist 请求方法:GET 需要认证:否 请求参数 参数名称 示例值 类型 是否必须 说明 path /zdir string 是 需要获取的目录 注意:path参数需要以/开头 请求成功 { "code": 200, "data": [ { "Name": "3.0.0", "Size": 4096, "Mtime": "2022-10-18 12:48:35", "Ftype": "folder", "Fpath": "/zdir/3.0.0", "Ext": "", "Link": "http://soft.xiaoz.org/public%2Fzdir%2F3.0.0" }, { "Name": "sh", "Size": 4096, "Mtime": "2022-10-26 10:07:00", "Ftype": "folder", "Fpath": "/zdir/sh", "Ext": "", "Link": "http://soft.xiaoz.org/public%2Fzdir%2Fsh" }, { "Name": "zdir_3.1.0_linux_amd64.tar.gz", "Size": 4038550, "Mtime": "2022-10-25 19:55:10", "Ftype": "file", "Fpath": "/zdir/zdir_3.1.0_linux_amd64.tar.gz", "Ext": "gz", "Link": "http://soft.xiaoz.org/public%2Fzdir%2Fzdir_3.1.0_linux_amd64.tar.gz" }, { "Name": "zdir_3.1.0_windows_amd64.tar.gz", "Size": 11470456, "Mtime": "2022-10-25 20:17:29", "Ftype": "file", "Fpath": "/zdir/zdir_3.1.0_windows_amd64.tar.gz", "Ext": "gz", "Link": "http://soft.xiaoz.org/public%2Fzdir%2Fzdir_3.1.0_windows_amd64.tar.gz" } ], "msg": "success" } 请求失败 { "code": -1000, "data": "", "msg": "文件夹不存在!" } 获取单个文件信息 接口说明 请求地址:/api/get/fileinfo 请求方法:POST 提交方式:multipart/form-data 需要认证:否 请求参数 参数名称 示例值 类型 是否必须 说明 fpath /zdir/zdir_3.1.0_linux_amd64.tar.gz string 是 文件路径 请求成功响应 { "code": 200, "data": { "Name": "zdir_3.1.0_linux_amd64.tar.gz", "Size": 4038550, "Mtime": "2022-10-25 19:55:10", "Fpath": "/zdir/zdir_3.1.0_linux_amd64.tar.gz", "Ext": "gz" }, "msg": "success" } 请求失败响应 { "code": -1000, "data": "", "msg": "只允许文件参数!" } 上传文件 接口说明 请求地址:/api/upload 请求方法:POST 提交方式:multipart/form-data 需要认证:是 请求参数 公共Header头部: 参数名称 示例值 类型 是否必须 说明 path /zdir string 是 Zdir文件路径 file file 是 本地文件 请求成功响应 { "code": 200, "data": "", "msg": "success" } 请求失败响应 { "code": -1000, "data": "", "msg": "文件夹不存在!" } 删除文件 接口说明 请求地址:/api/file/delete 请求方法:POST 提交方式:multipart/form-data 需要认证:是 请求参数 参数名称 示例值 类型 是否必须 说明 fpath /zdir/GPP_BenchMark.jpg string 是 文件路径 请求成功响应 { "code": 200, "data": "", "msg": "success" } 请求失败响应 { "code": -1000, "data": "", "msg": "文件不存在!" } 重命名文件 接口说明 请求地址:/api/file/rename 请求方法:POST 提交方式:multipart/form-data 需要认证:是 请求参数 公共Header头部: 参数名称 示例值 类型 是否必须 说明 fpath /zdir/ string 是 文件夹路径 old_name ExampleRun.bat string 是 原来的名称 new_name ExampleRun1.bat string 是 新的名称 请求成功响应 { "code": 200, "data": "", "msg": "success" } 新建文件夹 接口说明 请求地址:/api/dir/create 请求方法:POST 提交方式:multipart/form-data 需要认证:是 请求参数 参数名称 示例值 类型 是否必须 说明 path /zdir string 是 父级文件夹路径 name test string 是 文件夹名称 请求成功响应 { "code": 200, "data": "", "msg": "success" }