『政善治』Postman — 16.接口測(cè)試項(xiàng)目綜合練習(xí)（一）

接口測(cè)試項(xiàng)目實(shí)例網(wǎng)址：http://www.testingedu.com.cn:8081/inter/index.html。

接口簡(jiǎn)略說明：

  1. 鑒權(quán)接口：http://www.testingedu.com.cn:8081/inter/HTTP/auth

    該接口返回一個(gè)token值，之后的所有接口請(qǐng)求均需添加token頭域使用該token。

  2. 注冊(cè)接口：http://www.testingedu.com.cn:8081/inter/HTTP/register

  3. 登錄接口：http://testingedu.com.cn:8081/inter/HTTP/login

    該接口返回一個(gè)userid，在請(qǐng)求用戶信息時(shí)使用，因此保存為變量。

  4. 獲取用戶信息接口：http://testingedu.com.cn:8081/inter/HTTP/getUserInfo

    該接口需要使用登錄后所獲取的userid，因此使用之前保存的userid變量值。

  5. 注銷接口：http://testingedu.com.cn:8081/inter/HTTP/logout

說明：

接口測(cè)試項(xiàng)目實(shí)例中，訪問注冊(cè)、登錄、獲取用戶信息、登出接口之前，均需要調(diào)用auth接口獲取token數(shù)據(jù)。

因此需要通過auth接口獲取的token信息之后，存為變量供后續(xù)接口調(diào)用。

（一）項(xiàng)目接口文檔

1、/inter/HTTP/auth（鑒權(quán)）接口

  1. 功能說明
    獲取接口授權(quán)信息返，回授權(quán)后token。

    本接口是訪問平臺(tái)所有接口之前必須要調(diào)用的授權(quán)接口，只有通過該接口初始化token之后，才能訪問平臺(tái)其他接口。

    （auth接口就是獲取token接口，作用是鑒權(quán)。）

  2. 接口格式
    Json數(shù)據(jù)格式

  3. HTTP請(qǐng)求方式
    POST

  4. 輸入?yún)?shù)說明

    1）接口接收參數(shù)
    無
    2）頭部校驗(yàn)參數(shù)

    參數(shù)名稱 是否必須 類型 描述
    token N string 授權(quán)接口的token參數(shù)，如果已經(jīng)存在有效token，則需要帶上，此時(shí)不重新分配token；如果沒有有效的token，或者不帶token，都會(huì)重新分配token。

  5. 請(qǐng)求示例
    http://www.testingedu.com.cn:8081/inter/HTTP/auth

  6. 返回參數(shù)說明

    參數(shù)名稱 類型 描述
    status int 請(qǐng)求結(jié)果狀態(tài)碼：
    200：success token不存在或失效，創(chuàng)建token并返回
    201：success token未登錄
    202：success token已授權(quán)登錄，返回token。
    msg string 請(qǐng)求結(jié)果提示信息。與status對(duì)應(yīng)。
    token string 請(qǐng)求授權(quán)成功，返回token給客戶端。200和202狀態(tài)，會(huì)返回token。

  7. 正確返回示例

    {
 "status": 200,
 "msg": "success",
 "token": "109f1a34bdcf4785b6c70a9917d7a49d"
}

  8. 錯(cuò)誤返回示例

    無

2、/inter/HTTP/register（注冊(cè)）接口

  1. 功能說明
    注冊(cè)用戶。
    通過接口，向服務(wù)器提交參數(shù)，然后在平臺(tái)注冊(cè)自己的用戶賬號(hào)。

  2. 接口格式
    json

  3. HTTP請(qǐng)求方式.
    POST

  4. 輸入?yún)?shù)說明

    (1)接口接收參數(shù)如下：

    參數(shù)名稱 是否必須 類型 描述
    username Y string 用戶名參數(shù)，范圍[3，16]
    pwd Y string 密碼參數(shù)，范圍[3，16]
    nickname Y string 昵稱參數(shù)，范圍[3，36]
    describe N string 個(gè)人描述參數(shù)，范圍[0，127]

    (2)頭部校驗(yàn)參數(shù)

    參數(shù)名稱 是否必須 類型 描述
    token Y string 鑒定請(qǐng)求是否合法，用戶是否登錄。

  5. 請(qǐng)求示例

    http://www.testingedu.com.cn:8081/inter/HTTP/register

    參數(shù)如下：

    username: Will
    pwd: will
    nickname: Will
    describe: Will

  6. 返回參數(shù)說明

    參數(shù)名稱 類型 描述
    status int 請(qǐng)求結(jié)果狀態(tài)碼：
    200：恭喜您，注冊(cè)成功
    400：參數(shù)錯(cuò)誤
    401：用戶名已經(jīng)注冊(cè)
    402：參數(shù)錯(cuò)誤.
    405：非法請(qǐng)求
    406：登錄狀態(tài)，不能注冊(cè)
    msg string 請(qǐng)求結(jié)果提示信息。與status對(duì)應(yīng)。

  7. 正確返回示例

    {
 "status": 200,
 "msg": "恭喜您，注冊(cè)成功"
}

  8. 錯(cuò)誤的返回示例

    {
 "status": 405,
 "msg": "非法請(qǐng)求"
}

3、/inter/HTTP/login（登錄）接口

  1. 功能說明
    向服務(wù)器發(fā)送登錄鑒權(quán)。
    接口向服務(wù)器發(fā)送用戶名和密碼參數(shù)，通過登錄接口，去登錄平臺(tái)。登錄成功后，當(dāng)前使用的token會(huì)備注為已登錄狀態(tài)。

  2. 接口格式
    json

  3. HTTP請(qǐng)求方式.
    POST

  4. 輸入?yún)?shù)說明

    (1)接口接收參數(shù)如下：

    參數(shù)名稱 是否必須 類型 描述
    username Y string 用戶名參數(shù)，范圍[3，16]
    pwd Y string 密碼參數(shù)，范圍[3，16]

    (2)頭部校驗(yàn)參數(shù)

    參數(shù)名稱 是否必須 類型 描述
    token Y string 登錄接口的token參數(shù)，如果沒有該參數(shù)，不能請(qǐng)求登錄接口。如果有該參數(shù)，登錄成功后，該token會(huì)具備已登錄的狀態(tài)。

  5. 請(qǐng)求示例

    http://testingedu.com.cn:8081/inter/HTTP/login

    參數(shù)如下：

    username: xiaoming
    password: 123456

  6. 返回參數(shù)說明

    參數(shù)名稱 類型 描述
    status int 請(qǐng)求結(jié)果狀態(tài)碼：
    200：恭喜您，登錄成功
    401：用戶名密碼錯(cuò)誤
    402：參數(shù)錯(cuò)誤
    405：非法請(qǐng)求
    406：用戶已經(jīng)在別處登錄
    msg string 請(qǐng)求結(jié)果提示信息。與status對(duì)應(yīng)。
    id string 登錄成功后，返回當(dāng)前用戶的userid，其他情況不返回該字段。

  7. 正確返回示例

    {
 "status": 200,
 "msg": "恭喜您，登陸成功",
    "userid": "1"
}

  8. 錯(cuò)誤的返回示例

    {
 "status": 406,
 "msg": "非法請(qǐng)求"
}

4、/inter/HTTP/getUserInfo（用戶信息）接口

  1. 功能說明

    向服務(wù)器獲取指定id的用戶信息。
    該用戶的id必須與當(dāng)前用token登錄用戶一致，否則不能獲取。

  2. 接口格式
    json

  3. HTTP請(qǐng)求方式.
    POST

  4. 輸入?yún)?shù)說明

    (1)接口接收參數(shù)如下：

    參數(shù)名稱 是否必須 類型 描述
    username Y string 用戶id，范圍[1，10]

    (2)頭部校驗(yàn)參數(shù)

    參數(shù)名稱 是否必須 類型 描述
    token Y string 用來校驗(yàn)查詢信息的用戶是否是已經(jīng)登錄狀態(tài)。

  5. 請(qǐng)求示例

    http://testingedu.com.cn:8081/inter/HTTP/getUserInfo

    參數(shù)如下：

    id: 1

  6. 返回參數(shù)說明

    參數(shù)名稱 類型 描述
    status int 請(qǐng)求結(jié)果狀態(tài)碼：
    200：查詢成功
    401：您還未登錄
    402：參數(shù)錯(cuò)誤
    404：非法查詢
    405：非法請(qǐng)求
    406：token已失效
    msg string 請(qǐng)求結(jié)果提示信息。與status對(duì)應(yīng)。
    id string 查詢成功，返回用戶id；失敗不返回。
    nickname string 查詢成功，返回用戶昵稱信息；失敗不返回。
    describe string 查詢成功，返回用戶個(gè)人描述信息；失敗不返回。

  7. 正確返回示例

    {
 "status": 200,
 "msg": "查詢成功",
 "userid": "1",
 "nickname": "xiaohuahua",
 "describe": "擅長(zhǎng)Python、Java自動(dòng)化開發(fā)"
}

  8. 錯(cuò)誤的返回示例

    {
 "status": 405,
 "msg": "非法請(qǐng)求"
}

5、/inter/HTTP/logout（注銷）接口

  1. 功能說明

    注銷登錄（退出）。
    接口向服務(wù)器注銷當(dāng)前token登錄的用戶。

  2. 接口格式
    json

  3. HTTP請(qǐng)求方式.
    POST

  4. 輸入?yún)?shù)說明

    (1)接口接收參數(shù)

    無

    (2)頭部校驗(yàn)參數(shù)

    參數(shù)名稱 是否必須 類型 描述
    token Y string 用來校驗(yàn)用戶是否是已經(jīng)登錄狀態(tài)。

  5. 請(qǐng)求示例

    http://testingedu.com.cn:8081/inter/HTTP/logout

  6. 返回參數(shù)說明

    參數(shù)名稱 類型 描述
    status int 請(qǐng)求結(jié)果狀態(tài)碼：
    200：注銷成功
    406：token已失效
    msg string 請(qǐng)求結(jié)果提示信息。與status對(duì)應(yīng)。

  7. 正確返回示例

    {
 "status": 200,
 "msg": "用戶已退出登錄"
}

  8. 錯(cuò)誤的返回示例

    {
 "status": 406,
 "msg": "token已失效"
}

（二）網(wǎng)站上手動(dòng)驗(yàn)證

在實(shí)際的工作中，我們查看完文檔之后，需要到網(wǎng)站上進(jìn)行手動(dòng)操作，調(diào)用一下文檔中的接口，還可以借助抓包工具，來檢查一下文檔中有沒有表述上的問題。（也就是最基本的流程判斷）

通過實(shí)際操作得知如下流程：

  1. 用戶注冊(cè)的前后會(huì)調(diào)用auth（鑒權(quán)）接口。

  2. 用戶登陸后會(huì)調(diào)用查詢用戶信息接口，在調(diào)用查詢用戶信息接口前也會(huì)調(diào)用auth（鑒權(quán)）接口。

    也就是一個(gè)登陸操作，執(zhí)行了登陸，鑒權(quán)，查詢?nèi)齻€(gè)接口。

  3. 注銷用戶后會(huì)調(diào)用auth（鑒權(quán)）接口，使用戶鑒權(quán)失效。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容