diff --git a/application/index/view/index/api.html b/application/index/view/index/api.html index 948fb78c..81244542 100644 --- a/application/index/view/index/api.html +++ b/application/index/view/index/api.html @@ -5,96 +5,227 @@ {block name="main"}
-

1. 获取Token

-
-
-
- - - - - - - - - - - - - - - - - -
功能接口
请求方式POST
URL{$domain}/api/token
+
+

1. 获取Token

+
+
+
+ + + + + + + + + + + + + + + + + +
功能接口
请求方式POST
URL{$domain}/api/token
+
+

请求参数

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名称类型是否必须说明
emailString邮箱
passwordString账号密码
formatString返回数据格式,可选json、xml、jsonp,默认json
+
+

返回数据说明

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名称类型实例值说明
codeNumber200状态码,成功返回200,失败返回500
msgStringsuccess提示信息
timeNumber1544176295响应时间戳
dataarray|object{"token": "8961576c9090ef0902c4b89406f8d557"}获取的token数据
+
-

请求参数

-
- - - - - - - - - - - - - - - - - - - - - - - -
参数名称类型是否必须说明
emailString邮箱
passwordString账号密码
-
-

返回数据说明

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
参数名称类型实例值说明
codeNumber200状态码,成功返回200,失败返回500
msgStringsuccess提示信息
timeNumber1544176295响应时间戳
dataarray|object{"token": "8961576c9090ef0902c4b89406f8d557"}获取的token数据
+ +
+

2. 图片上传

+
+
+
+ + + + + + + + + + + + + + + + + +
功能接口
请求方式POST
URL{$domain}/api/upload
+
+
+
+

请求参数

+
+ + + + + + + + + + + + + + + + + + + + + + + +
参数名称类型是否必须说明
imageFile表单名称
formatString返回数据格式,可选json、xml、jsonp,默认json
+
+
+ 注意:请求时header如果有参数 token,接口则认证该token,上传的图片也是在该token用户下,否则为游客上传。 +
+

返回数据说明

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名称类型实例值说明
codeNumber200状态码,成功返回200,失败返回500
msgStringsuccess提示信息
timeNumber1544176295响应时间戳
dataarray|object +
{
+  "name": "9B7BCFBD05891B2D42187F126887777A.jpg",
+  "url": "http://域名/2018/12/08/5c0b519f44701.jpg"
+}
+
获取的token数据
+
+

上传示例

+
+POST /api/upload HTTP/1.1
+Host: {$domain}
+
+Connection: keep-alive
+Content-Length: 57398
+Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryx2mqINKHVPJ8yMdK
+
+------WebKitFormBoundaryx2mqINKHVPJ8yMdK
+Content-Disposition: form-data; name="image"; filename="test.png"
+Content-Type: image/png
+
+

响应错误示例

+
+{
+  "code": 500,
+  "msg": "管理员关闭了游客上传!",
+  "data": null,
+  "time": 1544245931
+}