Multimedia-Python

[TOC]

目錄

Json請求通用格式

{

"id":123456789,

"type":"xxx",

"subtype":"xxxx",

"data":{

"key":"value"

}

}

Json返回通用格式

{

"id":123456789,

"status":0,

"message":"successful",

"data":{

"key":"value"

}

}

所需參數介紹：

參數

介紹

調用方

樣例

id

事件處理id，整型，請求端發送，接收端返回時原樣返回

請求、返回

"id":123456

status

返回請求處理狀態，請求時status填寫0。默認返回0時為請求處理成功，若失敗返回錯誤碼

返回

"status":0

message

狀態簡略信息，若成功調用則返回"successful"，失敗返回錯誤信息

返回

"message":"successful"

type

請求類型

請求

"type":"user"

subtype

請求子類型

請求

"subtype":"login"

data

包含附加或返回的請求數據

請求、返回

"data":{"token":"xxxxxxxxxxxxx"}

驗證碼類

登錄圖片驗證碼

API說明

此API用于生成一個5位字母數字混合的圖形驗證碼

成功則返回圖片的base64數據和一個5位rand值。

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":事件ID, # 整數型

"type":"img",

"subtype":"generate",

"data":{}

}

Python端返回成功處理情況

{

"id":請求時的ID, # 整數型

"status":0,

"message":"successful",

"data":{

"imgdata":"iVBORw0yrfmx5m7975n32/23Y+cdf1Rv9oA6.....(以下省略)",

"rand":"CST43" #隨機文本

}

}

注意

id字段需是整型數據。若是文本型數字數據，返回時自動轉換成整數型數據；若是非數字型文本，則返回-1。id用于讓前端在服務繁忙時能夠對應服務;

Python成功返回時的imgdata為驗證碼base64圖片數據，前端獲得數據后進行轉碼再顯示;

rand為隨機字符串，前端獲得驗證碼后需要將驗證碼和rand文本MD5加密后傳給后端進行驗證，hash = MD5(code+rand)。

驗證碼不區分大小寫，請自行將驗證碼轉換成全部小寫再進行hash操作。

Python端返回失敗處理情況

{

"id":"請求時的ID",

"status":1000, # 錯誤碼

"message":"驗證碼文件創建失敗",

"data":{},

}

status傳遞的錯誤碼類型為整型。具體的錯誤碼詳見全局status表和局部status表。

所用到的全局status

status

-3

-2

-1

圖片驗證碼校驗

API說明

此API用于校驗用戶輸入的驗證碼是否正確，在目前版本中，此API暫時用不到

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":事件ID, # 整數型

"type":"img",

"subtype":"validate",

"data":{"hash":"asddwfw……"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

hash

string

32

cffb7f1eb316fd45bbfbd43082e36f9c

hash = MD5(imgcode + rand

注意

hash字段的數據要求是用戶填寫的驗證碼內容與rand文本進行MD5加密獲得。即hash = MD5(code + rand)

驗證碼不區分大小寫，請自行將驗證碼轉換成全部小寫再進行hash操作。

Python端返回成功處理情況

{

"id":請求時的ID, # 整數型

"status":0,

"message":"successful",

"data":{}

}

Python端返回失敗處理情況

{

"id":請求時的ID,

"status":-1, # 驗證碼hash值不匹配

"message":"驗證碼hash值不匹配",

"data":{},

}

status傳遞的錯誤碼類型為整型。具體的錯誤碼詳見全局status表和局部status表。

所用到的全局status

status

-404

-3

-2

-1

局部status表

status

message

內容

100

Error captcha hash

校驗失敗，驗證碼hash值不匹配(包括驗證碼過期)

手機短信驗證碼

API說明

最新修改：增加了command_type字段，可缺省，默認為1，用于判斷短信信息種類

此API用于以手機號作為賬號進行注冊時發送短信驗證碼

成功則向指定手機發送短信，并返回一個5位rand值，用于用戶注冊時

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":事件ID,

"type":"sms",

"subtype":"generate",

"data":{

"phone":"137xxxxxxxx",

"command_type":1

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

中國大陸11位手機號

command_type

√

int

1

1為注冊賬號，2為找回密碼

hash

√

string

32

cffb7f1eb316fd45bbfbd43082e36f9c

該字段目前不使用

hash = MD5(imgcode + rand

注意

phone字段需用文本型傳遞，且只能為中國大陸手機號，不支持國外手機號

hash字段的數據要求是用戶填寫的驗證碼內容與rand文本進行MD5加密獲得。即hash = MD5(code + rand)

Python端返回成功處理情況

{

"id":請求時的ID,

"status":0,

"message":"successful",

"data":{

"rand":"DSf4s"

}

}

注意：

新版本里將返回數據data中的code字段刪除了。

rand為隨機字符串，前端獲得驗證碼后需要將驗證碼和rand文本進行MD5加密后傳給后端端進行驗證，hash = MD5(code+rand)，此hash用于賬號注冊。

手機驗證碼的時效為3min，由后端處理。驗證碼超時后端會返回status = -4的錯誤。

Python端返回失敗處理情況

{

"id":請求時的ID,

"status":1016, #錯誤碼

"message":"手機號格式錯誤",

"data":{},

}

所用到的全局status

status

-404

-3

-2

-1

局部status表

status

具體錯誤碼請看騰訊云短信錯誤碼

注意

status傳遞的錯誤碼類型為整型。具體的錯誤碼參照騰訊云短信服務API文檔。

短信錯誤碼

用戶類

賬號登錄·手機

API說明

此API用于以手機號作為登錄憑證時的登錄請求

成功返回token值

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":1234,

"type":"login",

"subtype":"pass",

"data":{

"phone":"13750687010",

"pass":"wlc570Q0",

"enduring":False,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

pass

string

由前端決定

wlc570Q0

登錄密碼

enduring

√

int

1

False

是否為長效登錄，1為長效，0為非長效(無操作10min)

默認為0

注意

phone字段需用文本型傳遞

pass字段的長度由前端限制，后端只取其MD5值進行判斷

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"token": "debc454ea24827b67178482fd73f37c3"

}

}

注意：

獲取的token用于后期所有需要用戶驗證的請求操作。

賬號每登錄一次即可獲得一個token

一個賬號同時獲得10個以上的token時，自動刪除早期的token，維持token數在10以內

獲得的token未被用于任何操作超過10min后將被自動刪除(設置為長效token的除外)

若enduring傳遞了非int類型數據，則自動為0

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Error password",

"data":{},

}

所用到的全局status

status

-200

-3

-2

-1

局部status表

status

message

內容

100

Incorrect user

無該賬號記錄

101

Error password

用戶輸入的密碼錯誤

200

Invalid record number

有兩條及以上該賬號的數據

300

Add token failed

獲取token失敗

賬號注冊·手機

API說明

此API用于以手機號作為登錄憑證時的注冊請求

成功返回token值

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":0,

"status":0,

"type":"register",

"subtype":"phone",

"data":{

"phone":"13750687010",

"hash":"cffb7f1eb316fd45bbfbd43082e36f9c",

"pass":"wlc570Q0"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

hash

string

32

cffb7f1eb316fd45bbfbd43082e36f9c

此hash由手機驗證碼的code與rand進行MD5加密獲得

hash=MD5(smscode+rand)

pass

string

由前端決定

wlc570Q0

登錄密碼

注意

phone字段需用文本型傳遞

pass字段的長度由前端限制，后端只取其MD5值進行判斷

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Phone number existed",

"data":{},

}

所用到的全局status

status

-200

-3

-2

-1

局部status表

status

message

內容

100

Incorrect user data

創建賬號失敗

101

Phone number existed

手機號已存在

102

Incorrect user information

創建用戶資料失敗

200

Invalid record number

有兩條及以上該賬號的數據

400

Error hash

Hash校驗文本錯誤

密碼找回·手機

API說明

此API用于找回以手機號作為登錄憑證時的密碼找回

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":0,

"status":0,

"type":"password",

"subtype":"forget",

"data":{

"phone":"13750687010",

"hash":"cffb7f1eb316fd45bbfbd43082e36f9c",

"pass":"wlc570Q0"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

hash

string

32

cffb7f1eb316fd45bbfbd43082e36f9c

此hash由手機驗證碼的code與rand進行MD5加密獲得

hash=MD5(smscode+rand)

pass

string

由前端決定

wlc570Q0

登錄密碼

注意

使用api前，需要先調用一次短信驗證碼發送請求，且短信請求中command_type為2

phone字段需用文本型傳遞

pass字段的長度由前端限制，后端只取其MD5值進行判斷

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Phone number existed",

"data":{},

}

所用到的全局status

status

-200

-3

-2

-1

局部status表

status

message

內容

400

Error hash

Hash校驗文本錯誤

密碼修改·手機

API說明

此API用于找回以手機號作為登錄憑證時的密碼修改

API類型

請求類型：POST

API地址：

POST發送請求的json文本

{

"id":0,

"status":0,

"type":"password",

"subtype":"change",

"data":{

"phone":"13750687010",

"old":"wlc570Q0",

"new":"abc123"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

old

string

由前端決定

cffb7f1eb316fd45bbfbd43082e36f9c

老密碼

new

string

由前端決定

abc123

新密碼

注意

phone字段需用文本型傳遞

old、new字段的長度由前端限制，后端只取其MD5值進行判斷

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Phone number existed",

"data":{},

}

所用到的全局status

status

-200

-3

-2

-1

局部status表

status

message

內容

100

Incorrect user

無該賬號記錄

101

Error password

用戶輸入的密碼錯誤

200

Invalid record number

有兩條及以上該賬號的數據

300

Add token failed

獲取token失敗

用戶昵稱·獲取

API說明

此API用于通過phone值獲取對應用戶信息

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"info",

"subtype":"nickname",

"data":{

"user_id":"13750687010"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "Successful",

"data": {

"nickname": "FatBallFish"

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": 1,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-200

-100

-3

-2

-1

局部status表

status

message

內容

100

user not existed

賬號不存在

200

Unkonwn user info Error

同一phone大于2條

用戶信息·獲取

API說明

此API用于通過token值獲取對應用戶信息

API類型

請求類型：GET

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "Successful",

"data": {

"phone": "13750687010",

"name": "\u738b\u51cc\u8d85",

"nickname": "FatBallFish",

"email": "893721708@qq.com",

"level": 1

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": 1,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-200

-100

局部status表

status

message

內容

1

Error Token

token不正確

用戶信息·更新

API說明

此API用于更新用戶信息

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"info",

"subtype":"update",

"data":{

"phone":"13750687010",

"name":"王凌超",

"nickname":"FatBallFish",

"email":"893721708@qq.com"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

name

√

√

string

20

cffb7f1eb316fd45bbfbd43082e36f9c

nickname

√

√

string

20

wlc570Q0

登錄密碼

email

√

√

string

50

郵箱地址

level

√

int

1

用戶等級

注意

phone用作檢驗機制，不可被修改

level字段若被使用則必須傳遞數值，不能為空

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Phone number existed",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

用戶頭像·上傳

API說明

此API用于上傳用戶的頭像圖片

成功返回頭像的url地址

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"portrait",

"subtype":"upload",

"data":{

"base64":img_base64 # string型

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

base64

string

/9j/4AAQSkZJRgABAQEA.......(長度過長省略)

圖片的base64格式文本，前端盡量限制圖片大小在1M以下，否則容易卡頓，3M以上請求容易失敗

注意

base64可選擇是否帶有base頭標識，實際不影響。標識例子：data:image/jpg;base64,

若該用戶原先已有頭像，新頭像將自動覆蓋原有頭像，原頭像被刪除。

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"url": "./api/get/portrait/13750687010"

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-100, #錯誤碼

"message":"Missing necessary args",

"data":{},

}

所用到的全局status

status

-101

-100

-3

-2

-1

用戶頭像·獲取

API說明

此API用于通過token值獲取對應用戶信息

API類型

請求類型：GET

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

用戶id

API例子

Python端返回成功處理情況

二進制型圖片數據(bytes)

注意

前端調用此api時，直接將api地址寫在src中即可，例如：

Python端返回失敗處理情況

視情況返回以下三種圖片：

1.在服務器域名外訪問此api，返回“ban.jpg”，提示“多媒體站內圖片，禁止外部引用”

2.輸入的user_id不存在但格式正確返回“default.jpg”，即默認頭像

3.輸入的user_id格式出錯(出現非數字字符)，返回“error.jpg”，提示“參數傳遞錯誤，無法獲取圖片”

注意

調用此api時，請注意當前api所在地址，若非https://dmt.lcworkroom.cn或http://localhost這兩個根域名的話，將會返回ban.jpg

所用到的全局status

無

Token類

心跳doki

API說明

此API用于檢驗token是否有效，若有效并刷新token有效時間。

API類型

請求類型：GET

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

Python端返回成功處理情況

{

"id": id,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id": -1,

"status": 1,

"message": "Token not existed",

"data": {}

}

所用到的全局status

status

-200

-100

局部status表

status

message

內容

1

Token not existed

Token不存在

200

Invalid token number

同一Token大于2條

文章類

增加文章

API說明

此API用于增加論壇文章內容

成功返回article_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"add",

"data":{

"title":"測試文章",

"content":"王凌超"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"article_id":1565920055

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

更新文章

API說明

此API用于更新論壇文章內容

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"update",

"data":{

"article_id":1565920055,

"content":"王凌超"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

article_id

bigint

10

1565920055

文章id

content

string

這是一篇測試文章,測試一下更新效果

文章內容

注意

article_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error user_id

文章作者id與當前登錄id不一致

刪除文章

API說明

此API用于刪除論壇文章

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"delete",

"data":{

"article_id":1565920055}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

article_id

bigint

10

1565920055

文章id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error user_id

文章作者id與當前登錄id不一致

獲取文章列表

API說明

此API用于獲取游客論壇文章列表

API類型

請求類型：GET、POST

兩個請求功能一致，就是參數傳遞方式不一樣。

token只能傳在url中

API地址：

參數表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

keywords

√

√

string

測試

搜索關鍵字，設置后將以此關鍵字模糊匹配title和content字段內容，模糊匹配

article_id

√

√

int

10

1565926081

文章id，精確匹配

user_id

√

√

string

11

13750687010

用戶id，精確匹配

title

√

√

string

測試文章

文章標題，模糊匹配

content

√

√

string

這是

文章內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

mode

√

int

0

0

0為顯示文章源格式，1為文章簡介，自動返回第一行文字

注意

只傳遞token參數則返回所有文章

如果keywords不為空則優先使用keywords，article_id、title、content則被忽略；

keywords用于title和content的并集查詢，模糊匹配；

article_id、user_id、title、content可交集查詢；

order中可用于排序的字段有article_id, user_id, title,content,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

URL例程

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

{"article_id": 1565926081,

"user_id": "13750687010",

"nickename": "FatBallFish",

"title": "測試文章",

"content": "這是一篇測試文章",

"create_time": "2019-08-16 11:28:01",

"update_time": "2019-08-16 11:28:01"}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error Order

排序規則錯誤

101

Error num

num值錯誤，不能<1

評論類

增加評論

API說明

此API用于增加論壇文章的評論內容

成功返回article_id、comment_id、father_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"comment",

"subtype":"add",

"data":{

"article_id":1565926081,

"content":"這是一條用API請求的子級評論",

"father_id":"76bd7b76fcd0b23f3d171f39b416d936"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

article_id

int

10

1565926081

文章id

content

string

這是一篇測試文章

文章內容

father_id

√

√

string

32

76bd7b76fcd0b23f3d171f39b416d936

父評論id(MD5加密文本)，若為空則為根評論，默認為空

注意

article_id、father_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"article_id": 1565926081,

"comment_id": "354b6ded0748cd837d0ebf06230b9770",

"father_id":"76bd7b76fcd0b23f3d171f39b416d936"

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error father_id

父評論錯誤，很有可能不存在

更新評論

API說明

此API用于更新論壇文章評論內容

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"comment",

"subtype":"update",

"data":{

"comment_id":"d757d9ea4c9c1860299a0341524a6a7d",

"content":"這是一條用API更新的子級評論"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

comment_id

string

32

d757d9ea4c9c1860299a0341524a6a7d

評論id

content

string

這是一篇測試文章,測試一下更新效果

文章內容

注意

comment_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error comment_id

評論id錯誤，很有可能不存在

101

Error user_id

評論作者id與當前登錄id不一致

刪除評論

API說明

此API用于刪除論壇評論文章

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"comment",

"subtype":"delete",

"data":{

"comment_id":"a301c03e1248eabf83785b5548d603ec"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

comment_id

string

32

a301c03e1248eabf83785b5548d603ec

評論id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error comment_id

評論id錯誤，很有可能不存在

101

Error user_id

評論作者id與當前登錄id不一致

獲取評論列表

API說明

最新修改：增加user_id字段，可缺省，用于篩選該用戶發表過的所有評論

此API用于獲取游客論壇文章評論列表

API類型

請求類型：GET、POST

兩個請求功能一致，就是參數傳遞方式不一樣。

token只能傳在url中

API地址：

參數表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

article_id

int

10

1565926081

文章id，精確匹配

comment_id

√

√

string

32

d757d9ea4c9c1860299a0341524a6a7d

評論id，精確匹配

father_id

√

√

string

32

a301c03e1248eabf83785b5548d603ec

父評論id，精確匹配

user_id

√

√

string

11

13750687010

用戶id，精確匹配

content

√

√

string

這是一條評論內容

評論內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

注意

只傳遞token和article_id參數則返回該文章的所有根評論，不含子評論。

article_id、comment_id、father_id、user_id、content可交集查詢；

order中可用于排序的字段有article_id, user_id,comment_id、father_id、,content,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

URL例程

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 2,

"list": [

{

"article_id": 1565926081,

"comment_id": "76bd7b76fcd0b23f3d171f39b416d936",

"father_id": "",

"user_id": "13750687010",

"nickename": "FatBallFish",

"content": "這是一條更新過的評論",

"create_time": "2019-08-18 09:41:41",

"update_time": "2019-08-18 11:08:43"

},

{

"article_id": 1565926081,

"comment_id": "1aa6ddf68bea87f2305dd9fd5d3bb2c8",

"father_id": "",

"user_id": "13750687010",

"nickename": "FatBallFish",

"content": "這是一條測試評論",

"create_time": "2019-08-18 09:32:16",

"update_time": "2019-08-18 09:32:16"

}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error order

排序規則錯誤

101

Error num

num值錯誤，不能<1

102

Error article_id

錯誤的文章id

活動類

增加活動

API說明

此API用于增加論壇活動

成功返回active_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"add",

"data":{

"title":"校友召集令",

"content":"恰逢更名時機，召集校友來此一聚",

"start_time":"2019-08-24 00:00:00",

"end_time":"2019-8-25 0:0:0"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

start_time

datetime

2019-08-24 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

end_time

datetime

2019-08-25 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"active_id":78554587

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

更新活動

API說明

此API用于更新論壇活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"update",

"data":{

"active_id":78554587,

"title":"校友召集令",

"content":"恰逢更名時機，召集校友來此一聚，更新活動內容",

"start_time":"2019-08-25 00:00:00",

"end_time":"2019-08-26 00:00:00"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

active_id

int

8

78554587

活動id

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

start_time

datetime

2019-08-24 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

end_time

datetime

2019-08-25 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id

101

Error user_id

活動發起者id與當前登錄id不一致

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

刪除活動

API說明

此API用于刪除論壇活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"delete",

"data":{

"active_id":86889745

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id

101

Error user_id

活動發起者id與當前登錄id不一致

獲取活動列表

API說明

最新修改：增加user_id字段，可缺省，用于篩選該用戶參加過的所有活動

此API用于獲取論壇活動列表

API類型

請求類型：GET、POST

兩個請求功能一致，就是參數傳遞方式不一樣。

token只能傳在url中

API地址：

參數表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

keywords

√

√

string

測試

搜索關鍵字，設置后將以此關鍵字模糊匹配title和content字段內容，模糊匹配

active_id

√

√

int

8

78554587

活動id，精確匹配

user_id

√

√

str

13750687010

用戶id，精確匹配

title

√

√

string

測試文章

活動標題，模糊匹配

content

√

√

string

這是

活動內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

mode

√

int

0

0

0為顯示文章源格式，1為文章簡介，自動返回第一行文字

注意

只傳遞token參數則返回所有活動

如果keywords不為空則優先使用keywords，article_id、title、content則被忽略；

keywords用于title和content的并集查詢，模糊匹配；

active_id、user_id、title、content可交集查詢；

order中可用于排序的字段有active_id, user_id, title,content,start_time,end_time,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

URL例程

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

{"active_id": 78554587,

"user_id": "13750687010",

"nickename": "FatBallFish",

"title": "校友召集令",

"content": "恰逢更名時機，召集校友來此一聚，更新活動內容",

"start_time": "2019-08-25 00:00:00",

"end_time": "2019-08-26 00:00:00",

"create_time": "2019-08-24 15:29:57",

"update_time": "2019-08-24 15:29:57"}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error Order

排序規則錯誤

101

Error num

num值錯誤，不能<1

加入活動

API說明

此API用于用戶加入活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"join",

"data":{

"active_id":78554587,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id，可能并不存在

102

Already joined

用戶已加入此活動

退出活動

API說明

此API用于用戶加入活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"exit",

"data":{

"active_id":78554587,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id，可能并不存在

101

Error user_id

活動參與者id與當前登錄id不一致或無權限或該用戶未加入此活動

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

獲取活動成員列表

API說明

此API用于獲取論壇活動成員列表

API類型

請求類型：POST

API地址：

參數表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

active_id

int

8

78554587

活動id，精確匹配

order

√

√

string

update_time DESC

join_time ASC

排序規則，使用SQL語句，為空則默認以加入時間升序排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

注意

order中可用于排序的字段有active_id, user_id, title,content,start_time,end_time,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

URL例程

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

"13750687010"

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error Order

排序規則錯誤

102

Error active_id

錯誤的活動id

管理員類

admin-用戶類

admin-用戶列表·獲取

API說明

此API獲取所有用戶列表，僅管理員權限用戶可用

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得，管理員token

POST發送請求的json文本

{

"id":1234,

"type":"user",

"subtype":"list",

"data":{}

}

Python端返回成功處理情況

{

"id": 0,

"status": 0,

"message": "successful",

"data": [

{

"phone": "13566284913",

"name": "\u8bb8\u6df3\u7693",

"nickname": "\u8bb8\u5927\u5e05\u54e5",

"email": "1010549831@qq.com",

"level": 1},

{

"phone": "13750687010",

"name": "\u738b\u51cc\u8d85",

"nickname": "FatBallFish",

"email": "893721708@qq.com",

"level": 1},

{

"phone": "15857174214",

"name": null,

"nickname": null,

"email": null,

"level": 1},

{

"phone": "15925868186",

"name": null,

"nickname": null,

"email": null,

"level": 1},

{

"phone": "17767174231",

"name": null,

"nickname": null,

"email": null,

"level": 1},

{

"phone": "17816064319",

"name": "\u94b1\u4e39",

"nickname": "\u86cb\u86cb",

"email": "3391791582@qq.com",

"level": 1},

{

"phone": "19857160634",

"name": null,

"nickname": null,

"email": null,

"level": 1}

]

}

Python端返回失敗處理情況

{

"id":1234,

"status":-103, #錯誤碼

"message":"No permission to operate",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

admin-用戶信息·獲取

API說明

此API用于通過user_id值獲取對應用戶信息，僅管理員權限用戶可用

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"user",

"subtype":"info",

"data":{"phone":"13750687010"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "Successful",

"data": {

"phone": "13750687010",

"name": "\u738b\u51cc\u8d85",

"nickname": "FatBallFish",

"email": "893721708@qq.com",

"level": 1

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": 1,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

admin-用戶信息·更新

API說明

此API用于更新用戶信息，僅管理員權限用戶可用

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"user",

"subtype":"update",

"data":{

"phone":"13750687010",

"name":"王凌超",

"nickname":"FatBallFish",

"email":"893721708@qq.com"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

name

√

√

string

20

cffb7f1eb316fd45bbfbd43082e36f9c

nickname

√

√

string

20

wlc570Q0

登錄密碼

email

√

√

string

50

郵箱地址

level

√

int

1

用戶等級

注意

phone用作檢驗機制，不可被修改

level字段若被使用則必須傳遞數值，不能為空

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":101, #錯誤碼

"message":"Phone number existed",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

admin-用戶·刪除

API說明

此API用于通過user_id值刪除對應用戶，僅管理員權限用戶可用

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"user",

"subtype":"delete",

"data":{"phone":"13750687010"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

phone

string

11

13750687010

登錄賬號(手機號)

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id": -1,

"status": 1,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

admin-文章類

admin-文章列表·獲取

API說明

此API用于獲取游客論壇文章列表

獲取單篇文章信息也用此api，傳遞一個article_id參數即可獲取只有一個數據的列表

API類型

請求類型：POST

API地址：

url參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"article",

"subtype":"list",

"data":{

"user_id":"13750687010",

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

keywords

√

√

string

測試

搜索關鍵字，設置后將以此關鍵字模糊匹配title和content字段內容，模糊匹配

article_id

√

√

int

10

1565926081

文章id，精確匹配

user_id

√

√

string

11

13750687010

用戶id，精確匹配

title

√

√

string

測試文章

文章標題，模糊匹配

content

√

√

string

這是

文章內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

mode

√

int

0

0

0為顯示文章源格式，1為文章簡介，自動返回第一行文字

注意

不傳任何字段參數則返回所有文章

如果keywords不為空則優先使用keywords，article_id、title、content則被忽略；

keywords用于title和content的并集查詢，模糊匹配；

article_id、user_id、title、content可交集查詢；

order中可用于排序的字段有article_id, user_id, title,content,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

{"article_id": 1565926081,

"user_id": "13750687010",

"nickename": "FatBallFish",

"title": "測試文章",

"content": "這是一篇測試文章",

"create_time": "2019-08-16 11:28:01",

"update_time": "2019-08-16 11:28:01"}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error Order

排序規則錯誤

101

Error num

num值錯誤，不能<1

admin-增加文章

API說明

此API用于增加論壇文章內容

成功返回article_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"add",

"data":{

"user_id":"13750687010",

"title":"測試文章",

"content":"王凌超"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

文章作者id

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"article_id":1565920055

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

admin-更新文章

API說明

此API用于更新論壇文章內容

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"update",

"data":{

"user_id":"13750687010",

"article_id":1565920055,

"content":"王凌超"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

文章作者id

article_id

bigint

10

1565920055

文章id

title_id

√

string

11

測試標題

文章標題，可缺省

content

string

這是一篇測試文章,測試一下更新效果

文章內容

注意

article_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error user_id

文章作者id與當前登錄id不一致

admin-刪除文章

API說明

此API用于刪除論壇文章

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"article",

"subtype":"delete",

"data":{

"article_id":1565920055}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

文章作者id

article_id

bigint

10

1565920055

文章id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error user_id

文章作者id與當前登錄id不一致

admin-評論類

admin-評論列表·獲取

API說明

最新修改：增加user_id字段，可缺省，用于篩選該用戶發表過的所有評論

此API用于獲取游客論壇文章評論列表

API類型

請求類型：POST

API地址：

url參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"comment",

"subtype":"list",

"data":{

"user_id":"13750687010",

"article_id":1568546112,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

article_id

int

10

1565926081

文章id，精確匹配

comment_id

√

√

string

32

d757d9ea4c9c1860299a0341524a6a7d

評論id，精確匹配

father_id

√

√

string

32

a301c03e1248eabf83785b5548d603ec

父評論id，精確匹配

user_id

√

√

string

11

13750687010

用戶id，精確匹配

content

√

√

string

這是一條評論內容

評論內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

注意

只傳遞token和article_id參數則返回該文章的所有根評論，不含子評論。

article_id、comment_id、father_id、user_id、content可交集查詢；

order中可用于排序的字段有article_id, user_id,comment_id、father_id、,content,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 2,

"list": [

{

"article_id": 1565926081,

"comment_id": "76bd7b76fcd0b23f3d171f39b416d936",

"father_id": "",

"user_id": "13750687010",

"nickename": "FatBallFish",

"content": "這是一條更新過的評論",

"create_time": "2019-08-18 09:41:41",

"update_time": "2019-08-18 11:08:43"

},

{

"article_id": 1565926081,

"comment_id": "1aa6ddf68bea87f2305dd9fd5d3bb2c8",

"father_id": "",

"user_id": "13750687010",

"nickename": "FatBallFish",

"content": "這是一條測試評論",

"create_time": "2019-08-18 09:32:16",

"update_time": "2019-08-18 09:32:16"

}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error order

排序規則錯誤

101

Error num

num值錯誤，不能<1

102

Error article_id

錯誤的文章id

admin-增加評論

API說明

此API用于增加論壇文章的評論內容

成功返回article_id、comment_id、father_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"comment",

"subtype":"add",

"data":{

"article_id":1565926081,

"user_id":"13750687010"

"content":"這是一條用API請求的子級評論",

"father_id":"76bd7b76fcd0b23f3d171f39b416d936"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

article_id

int

10

1565926081

文章id

user_id

string

11

13750687010

評論者id

content

string

這是一篇測試文章

文章內容

father_id

√

√

string

32

76bd7b76fcd0b23f3d171f39b416d936

父評論id(MD5加密文本)，若為空則為根評論，默認為空

注意

article_id、father_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"article_id": 1565926081,

"comment_id": "354b6ded0748cd837d0ebf06230b9770",

"father_id":"76bd7b76fcd0b23f3d171f39b416d936",

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error article_id

文章id錯誤，很有可能不存在

101

Error father_id

父評論錯誤，很有可能不存在

admin-更新評論

API說明

此API用于更新論壇文章評論內容

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"comment",

"subtype":"update",

"data":{

"user_id":"13750687010",

"comment_id":"d757d9ea4c9c1860299a0341524a6a7d",

"content":"這是一條用API更新的子級評論"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

評論者id

comment_id

string

32

d757d9ea4c9c1860299a0341524a6a7d

評論id

content

string

這是一篇測試文章,測試一下更新效果

文章內容

注意

user_id、comment_id用作檢驗機制，不可被修改

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error comment_id

評論id錯誤，很有可能不存在

101

Error user_id

評論作者id與當前登錄id不一致或無權限

admin-刪除評論

API說明

此API用于刪除論壇評論文章

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"comment",

"subtype":"delete",

"data":{

"user_id":"13750687010",

"comment_id":"a301c03e1248eabf83785b5548d603ec"}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

評論者id

comment_id

string

32

a301c03e1248eabf83785b5548d603ec

評論id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":100, #錯誤碼

"message":"Error article_id",

"data":{},

}

所用到的全局status

status

-200

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error comment_id

評論id錯誤，很有可能不存在

101

Error user_id

評論作者id與當前登錄id不一致或無權限

admin-活動類

admin-活動列表·獲取

API說明

最新修改：增加user_id字段，可缺省，用于篩選該用戶參加過的所有活動

此API用于獲取論壇活動列表

API類型

請求類型：POST

token只能傳在url中

API地址：

url參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"active",

"subtype":"list",

"data":{

"user_id":"13750687010",

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

keywords

√

√

string

測試

搜索關鍵字，設置后將以此關鍵字模糊匹配title和content字段內容，模糊匹配

active_id

√

√

int

8

78554587

活動id，精確匹配

user_id

√

√

str

13750687010

用戶id，精確匹配

title

√

√

string

測試文章

活動標題，模糊匹配

content

√

√

string

這是

活動內容，模糊匹配

order

√

√

string

update_time DESC

title ASC,update_time DESC

排序規則，使用SQL語句，為空則默認以更新時間進行排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

mode

√

int

0

0

0為顯示文章源格式，1為文章簡介，自動返回第一行文字

注意

只傳遞token參數則返回所有活動

如果keywords不為空則優先使用keywords，article_id、title、content則被忽略；

keywords用于title和content的并集查詢，模糊匹配；

active_id、user_id、title、content可交集查詢；

order中可用于排序的字段有active_id, user_id, title,content,start_time,end_time,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

{

"active_id": 78554587,

"user_id": "13750687010",

"nickname": "FatBallFish",

"title": "\u6821\u53cb\u53ec\u96c6\u4ee42",

"content": "\u6070\u9022\u66f4\u540d\u65f6\u673a\uff0c\u53ec\u96c6\u6821\u53cb\u6765\u6b64\u4e00\u805a\uff0c\u66f4\u65b0\u6d3b\u52a8\u5185\u5bb9",

"start_time": "2019-08-25 00:00:00",

"end_time": "2019-08-26 00:00:00",

"create_time": "2019-08-24 15:29:57",

"update_time": "2019-08-24 16:13:14"

}

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error Order

排序規則錯誤

101

Error num

num值錯誤，不能<1

admin-活動成員列表·獲取

API說明

此API用于獲取論壇活動成員列表

API類型

請求類型：POST

API地址：

url參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":0,

"type":"active",

"subtype":"member",

"data":{

"active_id":78554587,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

默認值

例子

備注

active_id

int

8

78554587

活動id，精確匹配

order

√

√

string

update_time DESC

join_time ASC

排序規則，使用SQL語句，為空則默認以加入時間升序排序

start

√

√

int

0

0

記錄索引開始，默認起始為 0

num

√

√

int

50

10

返回記錄數，默認返回50條

注意

order中可用于排序的字段有active_id, user_id, title,content,start_time,end_time,create_time, update_time;

order排序方法有：升序asc、降序desc，大小寫不區分。多條件排序時用英文半角,分割

當實際記錄數小于num的值時，只返回實際記錄數量的記錄

Python端返回成功處理情況

{

"id": -1,

"status": 0,

"message": "successful",

"data": {

"num": 1,

"list": [

"13750687010"

]

}

}

Python端返回失敗處理情況

{

"id": -1,

"status": -101,

"message": "Error Token",

"data": {}

}

所用到的全局status

status

-203

-200

-101

-100

局部status表

status

message

內容

100

Error Order

排序規則錯誤

102

Error active_id

錯誤的活動id

admin-增加活動

API說明

此API用于增加論壇活動，僅管理員使用

成功返回active_id

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"add",

"data":{

"user_id":"13750687010",

"title":"校友召集令",

"content":"恰逢更名時機，召集校友來此一聚",

"start_time":"2019-08-24 00:00:00",

"end_time":"2019-8-25 0:0:0"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

活動發起者id

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

start_time

datetime

2019-08-24 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

end_time

datetime

2019-08-25 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {

"active_id":78554587

}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

admin-更新活動

API說明

此API用于更新論壇活動，僅管理員使用

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"update",

"data":{

"user_id":"13750687010",

"active_id":78554587,

"title":"校友召集令",

"content":"恰逢更名時機，召集校友來此一聚，更新活動內容",

"start_time":"2019-08-25 00:00:00",

"end_time":"2019-08-26 00:00:00"

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

活動發起者id

active_id

int

8

78554587

活動id

title

string

255

測試文章

文章id

content

string

這是一篇測試文章

文章內容

start_time

datetime

2019-08-24 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

end_time

datetime

2019-08-25 00:00:00

請按照標準的時間格式文本進行傳遞，否則會報錯

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id

101

Error user_id

活動發起者id與當前登錄id不一致

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

admin-刪除活動

API說明

此API用于刪除論壇活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"delete",

"data":{

"user_id":"13750687010",

"active_id":86889745

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

活動發起者id

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id

101

Error user_id

活動發起者id與當前登錄id不一致

admin-加入活動

API說明

此API用于用戶加入活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"join",

"data":{

"user_id":"13750687010",

"active_id":78554587,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

string

11

13750687010

參與者id

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id，可能并不存在

102

Already joined

用戶已加入此活動

admin-退出活動

API說明

此API用于用戶加入活動

API類型

請求類型：POST

API地址：

url 參數表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

token

string

32

debc454ea24827b67178482fd73f37c3

由登錄api返回獲得

POST發送請求的json文本

{

"id":1234,

"type":"active",

"subtype":"exit",

"data":{

"user_id":"13750687010",

"active_id":78554587,

}

}

data字段表

參數

可否為空

可否缺省

數據類型

字段長度

例子

備注

user_id

stirng

11

13750687010

活動參與者id

active_id

int

8

78554587

活動id

Python端返回成功處理情況

{

"id": 1234,

"status": 0,

"message": "Successful",

"data": {}

}

Python端返回失敗處理情況

{

"id":1234,

"status":-200, #錯誤碼

"message":"Failure to operate database",

"data":{},

}

所用到的全局status

status

-200

-103

-101

-100

-3

-2

-1

局部status表

status

message

內容

100

Error active_id

錯誤的活動id，可能并不存在

101

Error user_id

活動參與者id與當前登錄id不一致或無權限或該用戶未加入此活動

102

Error format or data for time

開始時間或結束時間格式或數據錯誤

全局Status表

所有的全局status值皆小于0

大于 0 的status值皆為請求局部status值

參數

Message

內容

請求類型

0

successful

函數處理正確

POST、GET

-1

Error JSON key

json文本必需key缺失

POST

-2

Error JSON value

json文本value錯誤

POST

-3

Error data key

data數據中必需key缺失

POST

-4

Error Hash

Hash校驗文本錯誤

POST

-100

Missing necessary args

api地址中缺少token參數

POST、GET

-101

Error token

token不正確

POST、GET

-102

Get userid failed for the token

使用該token獲取userid失敗

POST、GET

-103

No permission to operate

用戶無權操作

POST

-200

Failure to operate database

數據庫操作失敗，檢查SQL語句是否正確

POST、GET

-201

Necessary key-value can't be empty

關鍵鍵值對值不可為空

POST

-202

Missing necessary data key-value

缺少關鍵的鍵值對

POST

-203

Arg's value type error

鍵值對數據類型錯誤

POST

-204

Arg's value error

鍵值對數據錯誤

POST

-404

Unknown Error

未知的Redis錯誤

POST

-500

COS upload Error

COS儲存上傳失敗

POST

status傳遞的錯誤碼類型為整型。

手機驗證碼相關的錯誤碼詳見短信錯誤碼

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的python设计大赛_GitHub - FatBallFish/Multimedia-Python: 多媒体设计大赛-Python后端的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。