當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

CoderHub接口文档

發布時間：2024/7/5 编程问答 28 豆豆

生活随笔收集整理的這篇文章主要介紹了 CoderHub接口文档小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

CoderHub接口文檔

Coderhub旨在創建一個程序員分享生活動態的平臺。

完成的功能如下：

用戶管理系統

內容管理系統

內容評論管理

內容標簽管理

文件管理系統

接口完整請求示例：http://127.0.0.1:8000/users

github倉庫：https://github.com/zep03/koa-coderhub（接口文檔編寫整理不易，如果幫到了您，麻煩給一個star，謝謝！）

一、用戶管理系統

1. 用戶注冊

1.1 基本信息

Path： /users

Method： POST

**接口描述：**用戶注冊接口

1.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type

application/json

是

Body

參數名稱類型是否必須默認值示例備注

name	String	是	無
password	String	是	無

{"name": "zep6","password": "123456" }

1.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 15,"info": "","serverStatus": 2,"warningStatus": 0 }

1.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤
包括：參數缺失（用戶名或者密碼不能為空）

409 用戶已存在

500 服務器內部異常

2. 用戶登錄

2.1 基本信息

Path： /login

Method： POST

**接口描述：**用戶登錄接口

2.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type

application/json

是

Body

參數名稱類型是否必須默認值示例備注

name	String	是	無
password	String	是	無

{"name": "zep6","password": "123456" }

2.3 返回數據

{"id": 15,"name": "zep6","token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTUsIm5hbWUiOiJ6ZXA2IiwiaWF0IjoxNjI5MDI3MDgwLCJleHAiOjE2MjkxMTM0ODB9.d6KKRSm2G_29-cKeI6wKRJRpXeVao82kHoboBvKiRjsSVRD71GQWOMv3TfktfgtexfijY1suNkFH8O0n6StRBPwyWWo-Tgm02M1DxrQ9j7mwUpch8l4pZPliM2Jv8tysAuCflzz2lEYrZ08EnG3kSxksEez-1BtumD46vtv3_GA" }

token說明：

token用于訪問需要身份認證的普通接口，有效期1天

2.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤
包括：參數缺失（用戶名或者密碼不能為空）、用戶名不存在、密碼錯誤等

500 服務器內部異常

3. 獲取用戶頭像

3.1 基本信息

Path： /users/:userId/avatar

Method： GET

**接口描述：**獲取用戶頭像的接口

3.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數，

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Params

參數名稱類型是否必須默認值示例備注

userId

String

是

無

3.3 返回數據

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-IUcyouYp-1629040885767)(C:\Users\Zep\AppData\Roaming\Typora\typora-user-images\image-20210815200024057.png)]

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤
包括：參數缺失

500 服務器內部異常

4. 測試登錄接口

4.1 基本信息

Path：/test

Method： POST

**接口描述：**用戶測試登錄接口

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Body

參數名稱類型是否必須默認值示例備注

無

4.3 返回數據

授權成功

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

二、內容管理系統

1. 發布動態

1.1 基本信息

Path：/moment

Method： POST

**接口描述：**發布動態接口

1.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Body

參數名稱類型是否必須默認值示例備注

content

String

是

無

{"content": "我是動態內容111" }

1.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 26,"info": "","serverStatus": 2,"warningStatus": 0 }

1.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

2. 獲取動態列表

1.1 基本信息

Path：/moment?offset=0&size=5

舉例：http://localhost:8000/moment?offset=0&size=5

Method： GET

**接口描述：**獲取動態列表接口

2.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type

application/json

是

Query

參數名稱類型是否必須默認值示例備注

offset	String	是	無	0	跳過幾條數據
size	String	是	無	5	返回數據的大小

Body

參數名稱類型是否必須默認值示例備注

無

2.3 返回數據

[{"id": 1,"content": "我說錯了，C語言才是最好的語言~","createAt": "2020-11-23T14:05:23.000Z","updateTime": "2020-11-27T13:35:42.000Z","author": {"id": 4,"name": "lucy","avatarUrl": "http://localhost:8000/users/4/avatar"},"commentCount": 6,"labelCount": 4},{"id": 3,"content": "曾幾何時，他也好，她也好，都是這家伙的被害者。所以我才憎惡著。這個強求著所謂“大家”的世界。必須建立在犧牲某人之上才能成立的低劣的和平。以溫柔和正義粉飾，明明是惡毒之物卻登大雅之堂，隨著時間的流逝越發兇惡，除欺瞞外別無其二的空虛的概念。過去和世界都是無法改變的。發生過的事情和所謂的“大家”都是無法改變的。但是，并不是說自己只能隸屬于他們","createAt": "2020-11-23T14:21:19.000Z","updateTime": "2020-11-23T14:21:19.000Z","author": {"id": 1,"name": "coderwhy","avatarUrl": null},"commentCount": 1,"labelCount": 0},{"id": 4,"content": "不要告訴我你不需要保護，不要告訴我你不寂寞，知微，我只希望你，在走過黑夜的那個時辰，不要倔強的選擇一個人。","createAt": "2020-11-23T14:21:19.000Z","updateTime": "2020-11-23T14:21:19.000Z","author": {"id": 3,"name": "lilei","avatarUrl": null},"commentCount": 0,"labelCount": 0},{"id": 5,"content": "If you shed tears when you miss the sun, you also miss the stars.如果你因失去了太陽而流淚，那么你也將失去群星了。","createAt": "2020-11-23T14:21:19.000Z","updateTime": "2020-11-23T14:21:19.000Z","author": {"id": 1,"name": "coderwhy","avatarUrl": null},"commentCount": 0,"labelCount": 0},{"id": 6,"content": "在世間萬物中我都發現了你，渺小時，你是陽光下一粒種子，偉大時，你隱身在高山海洋里。","createAt": "2020-11-23T14:21:19.000Z","updateTime": "2020-11-23T14:21:19.000Z","author": {"id": 2,"name": "kobe","avatarUrl": null},"commentCount": 0,"labelCount": 0} ]

2.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

3. 獲取動態詳情

3.1 基本信息

Path：/moment/:momentId

Method： GET

**接口描述：**獲取動態詳情接口

3.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type

application/json

是

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

3.3 返回數據

{"id": 24,"content": "JS是世界上最好的語言~","createAt": "2021-08-13T05:26:56.000Z","updateTime": "2021-08-13T05:26:56.000Z","author": {"id": 14,"name": "zep5","avatarUrl": "http://localhost:8000/users/14/avatar"} }

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

4. 修改動態

4.1 基本信息

Path：/moment/:momentId

Method： PATCH

接口描述：修改動態接口，該接口只允許用戶修改自己所發布的動態，不允許用戶修改其他用戶發布的動態！

修改其他用戶發布的動態將返回403 UNPERMISSION 您不具備操作的權限

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

content

String

是

無

{"content": "啦啦啦啦啦~~" }

4.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 0,"info": "Rows matched: 1 Changed: 1 Warnings: 0","serverStatus": 2,"warningStatus": 0,"changedRows": 1 }

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

5. 刪除動態

5.1 基本信息

Path：/moment/:momentId

Method： DELETE

接口描述：刪除動態接口，該接口只允許用戶刪除自己所發布的動態，不允許用戶刪除其他用戶發布的動態！

刪除其他用戶發布的動態將返回403 UNPERMISSION 您不具備操作的權限

5.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

5.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 0,"info": "","serverStatus": 2,"warningStatus": 0 }

5.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

三、內容標簽管理

1. 給動態添加標簽

1.1 基本信息

Path：/moment/:momentId/labels

Method： POST

接口描述：給動態添加標簽的接口，該接口只允許用戶為自己所發布的動態添加標簽，不允許用戶為其他用戶發布的動態添加標簽！

為其他用戶發布的動態添加標簽，將返回403 UNPERMISSION 您不具備操作的權限

1.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

labels

Array

是

無

{"labels": ["HTML", "VUE", "JWT"] }

1.3 返回數據

{"statusCode": 200,"message": "給動態添加標簽成功" }

1.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

2. 根據momentId查詢標簽

2.1 基本信息

Path：/moment/:momentId/labels

Method： GET

**接口描述：**根據momentId查詢標簽的接口

2.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

2.3 返回數據

[{"labelId": 3,"labelName": "愛情","momentId": 24},{"labelId": 16,"labelName": "后端","momentId": 24},{"labelId": 17,"labelName": "python","momentId": 24},{"labelId": 19,"labelName": "css","momentId": 24},{"labelId": 21,"labelName": "HTML","momentId": 24},{"labelId": 22,"labelName": "VUE","momentId": 24},{"labelId": 23,"labelName": "JWT","momentId": 24} ]

2.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

3. 添加標簽

3.1 基本信息

Path：/label

Method： POST

**接口描述：**添加標簽接口

3.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Body

參數名稱類型是否必須默認值示例備注

name

String

是

無

標簽名稱

{"name": "JavaEE" }

3.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 24,"info": "","serverStatus": 2,"warningStatus": 0 }

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

4. 獲取標簽列表

4.1 基本信息

Path：/label?limit=5&offset=0

舉例： http://localhost:8000/label?limit=5&offset=0

Method： GET

**接口描述：**獲取標簽列表接口

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數）：

Headers

參數名稱參數值是否必須示例備注

無

是

Query

參數名稱類型是否必須默認值示例備注

limit	String	是	無	5	一次請求返回的標簽個數
offset	String	是	無	0	跳過幾條數據

4.3 返回數據

[{"id": 1,"name": "前端","createAt": "2020-11-30T13:06:04.000Z","updateAt": "2020-11-30T13:06:04.000Z"},{"id": 2,"name": "文學","createAt": "2020-11-30T13:13:50.000Z","updateAt": "2020-11-30T13:13:50.000Z"},{"id": 3,"name": "愛情","createAt": "2020-11-30T13:13:53.000Z","updateAt": "2020-11-30T13:13:53.000Z"},{"id": 4,"name": "青春","createAt": "2020-11-30T13:14:04.000Z","updateAt": "2020-11-30T13:14:04.000Z"},{"id": 5,"name": "C語言","createAt": "2020-11-30T13:35:10.000Z","updateAt": "2020-11-30T13:35:10.000Z"} ]

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

500 服務器內部異常

四、內容評論管理

1. 發表評論

1.1 基本信息

Path：/comment

Method： POST

**接口描述：**發表評論的接口

1.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

無

Body

參數名稱類型是否必須默認值示例備注

momentId	Int	是	無
content	String	是	無

{"momentId": 24,"content": "評論momentId為24的動態" }

1.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 18,"info": "","serverStatus": 2,"warningStatus": 0 }

1.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

2. 回復評論

2.1 基本信息

Path：/comment/:commentId/reply

Method： POST

**接口描述：**回復評論的接口

2.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

commentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

momentId	Int	是	無
content	String	是	無

{"momentId": 24,"content": "我是評論momentId為24的一條評論" }

2.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 22,"info": "","serverStatus": 2,"warningStatus": 0 }

2.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

3. 修改評論

3.1 基本信息

Path：/comment/:commentId

Method： PATCH

接口描述：修改評論的接口, 該接口只允許用戶修改自己發布的評論，不允許用戶修改其他用戶發布的評論！

修改其他用戶發布的評論，將返回403 UNPERMISSION 您不具備操作的權限

3.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

commentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

content

String

是

無

{"content": "我修改自己發布的id為22的評論" }

3.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 0,"info": "Rows matched: 1 Changed: 1 Warnings: 0","serverStatus": 2,"warningStatus": 0,"changedRows": 1 }

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

4. 刪除評論

4.1 基本信息

Path：/comment/:commentId

Method： DELETE

接口描述：刪除評論的接口, 該接口只允許用戶刪除自己發布的評論，不允許用戶刪除其他用戶發布的評論！

刪除其他用戶發布的評論，將返回403 UNPERMISSION 您不具備操作的權限

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	application/json	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

commentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

4.3 返回數據

{"fieldCount": 0,"affectedRows": 1,"insertId": 0,"info": "","serverStatus": 2,"warningStatus": 0 }

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

5. 根據動態id獲取評論列表

5.1 基本信息

Path：/moment?momentId=24

舉例：http://localhost:8000/comment?momentId=24

Method： GET

**接口描述：**根據動態id獲取評論列表的接口

5.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Query

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

5.3 返回數據

[{"id": 9,"content": "js不是最好的語言","commentId": null,"createTime": "2021-08-13T13:08:14.000Z","user": {"id": 14,"name": "zep5"}},{"id": 10,"content": "js不是最好的語言","commentId": null,"createTime": "2021-08-13T13:11:03.000Z","user": {"id": 14,"name": "zep5"}},{"id": 11,"content": "世界上沒有最好的語言~~","commentId": 9,"createTime": "2021-08-13T13:28:42.000Z","user": {"id": 14,"name": "zep5"}},{"id": 12,"content": "世界上沒有最好的語言~~","commentId": 9,"createTime": "2021-08-13T13:28:49.000Z","user": {"id": 14,"name": "zep5"}},{"id": 13,"content": "世界上沒有最好的語言~~","commentId": 9,"createTime": "2021-08-13T13:29:25.000Z","user": {"id": 14,"name": "zep5"}},{"id": 18,"content": "評論momentId為24的動態","commentId": null,"createTime": "2021-08-15T14:06:33.000Z","user": {"id": 14,"name": "zep5"}},{"id": 21,"content": "我是評論momentId為2的一條評論","commentId": 18,"createTime": "2021-08-15T14:17:55.000Z","user": {"id": 14,"name": "zep5"}}

5.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

五、文件管理系統

1. 用戶上傳頭像

1.1 基本信息

Path：/upload/avatar

Method： POST

**接口描述：**用戶上傳頭像的接口

1.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	multipart/form-data; boundary=	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Params

參數名稱類型是否必須默認值示例備注

無

Body

參數名稱類型是否必須默認值示例備注

avatar

File

是

無

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-wVUqvqdK-1629040885769)(CoderHub接口文檔.assets/image-20210815225524847.png)]

1.3 返回數據

{"statusCode": 200,"message": "上傳頭像成功" }

1.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

2. 上傳動態的配圖

2.1 基本信息

Path：/upload/picture/?momentId=1

舉例: http://localhost:8000//upload/picture?momentId=1

Method： POST

**接口描述：**上傳動態的配圖的接口

2.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

Content-Type	multipart/form-data; boundary=	是
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTQsIm5hbWUiOiJ6ZXA1IiwiaWF0IjoxNjI5MDEzOTgyLCJleHAiOjE2MjkxMDAzODJ9.MpIFWPy8ojLXFj8LmcC18J8X8bxSmQf_fH3tqttNvfvCb7ck7piVgus37M8YN4r-dQiit9Wn6gxcEMQsj4ppxgz6ESpDVd9BeYbG12GJ3d4CWqZYII3K5bR1VCq-OYLhwgUAgyvyRGmUdl1HnUWMIvIwl4ZVvujiVdMqSGR_wSM	是

注意：

在Authorization 請求頭中攜帶的token，格式為"Bearer "拼接上token，注意Bearer后有一個空格

token說明：token用于訪問需要身份認證的普通接口，有效期1天

Query

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

avatar

File

是

無

注意：一次請求最大可允許上傳9張配圖

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-sXiuX5aN-1629040885770)(CoderHub接口文檔.assets/image-20210815230049942.png)]

2.3 返回數據

動態的配圖上傳完成！

2.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

3. 根據filename獲取動態配圖

3.1 基本信息

Path：/moment/images/:filename

Method： GET

**接口描述：**根據filename獲取動態配圖的接口。

注意：

該接口獲取動態配圖時，可根據前端業務需求，返回三種規格大小的圖片

大圖：http://localhost:8000/moment/images/59f56a3b77a12416698847fe87372269?type=large

中圖：http://localhost:8000/moment/images/59f56a3b77a12416698847fe87372269?type=middle

小圖：http://localhost:8000/moment/images/59f56a3b77a12416698847fe87372269?type=small

3.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Params

參數名稱類型是否必須默認值示例備注

filename

String

是

無

59f56a3b77a12416698847fe87372269、 59f56a3b77a12416698847fe87372269?type=small、59f56a3b77a12416698847fe87372269?type=middle、59f56a3b77a12416698847fe87372269?type=large

Query

參數名稱類型是否必須默認值示例備注

type

無

否

null

圖片的類型：large(大圖)、middle(中圖)、small(小圖)。 1.可不傳這個type參數，不傳時默認展示中圖大小； 2. type參數值如果不是large、middle、small這三個中的一個，也默認展示中圖大小的圖片

3.3 返回數據

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-Phxtknc1-1629040885771)(CoderHub接口文檔.assets/image-20210815215647632.png)]

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

4. 根據momentId獲取動態配圖

4.1 基本信息

Path：/moment/img/:momentId

Method： GET

**接口描述：**根據momentId查詢動態配圖的接口

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

4.3 返回數據

{"statusCode": 200,"message": "獲取動態配圖成功","imageList": [{"imgUrl": "http://localhost:8000/moment/images/107632322c8ed31f1901d0bfe6aca4f9","mimetype": "image/png","size": 726597}] }

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

---- | :— | ------------------------------------------------------------ |
| type | 無 | 否 | null | | 圖片的類型：large(大圖)、middle(中圖)、small(小圖)。 1.可不傳這個type參數，不傳時默認展示中圖大小； 2. type參數值如果不是large、middle、small這三個中的一個，也默認展示中圖大小的圖片 |

3.3 返回數據

[外鏈圖片轉存中…(img-Phxtknc1-1629040885771)]

3.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

4. 根據momentId獲取動態配圖

4.1 基本信息

Path：/moment/img/:momentId

Method： GET

**接口描述：**根據momentId查詢動態配圖的接口

4.2 請求參數

請求參數（GET 方法就是 Query 參數，POST 方法就是 Body 參數

/users/:userId/avatar里的**:userId就是Params參數**）：

Headers

參數名稱參數值是否必須示例備注

無

Params

參數名稱類型是否必須默認值示例備注

momentId

String

是

無

Body

參數名稱類型是否必須默認值示例備注

無

4.3 返回數據

{"statusCode": 200,"message": "獲取動態配圖成功","imageList": [{"imgUrl": "http://localhost:8000/moment/images/107632322c8ed31f1901d0bfe6aca4f9","mimetype": "image/png","size": 726597}] }

4.4 返回HTTP狀態碼

200 OK

400 請求參數錯誤

401 UNAUTHORIZATION 無效的token

403 UNPERMISSION 您不具備操作的權限

404 NOT FOUND

500 服務器內部異常

總結

以上是生活随笔為你收集整理的CoderHub接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。

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

上一篇：四、PHP基础——会话技术Cookie
下一篇：一、数据预处理——数据归一化数据标准