接口編程的基本操作（一文教你寫接口的整個過程及其中的細節）

2023-10-19 01:36:52

最近，在做測試開發平臺的時候，需要對測試用例的列表進行後端分頁，在實際去寫代碼和測試的過程中，發現這裡面還是有些細節的，故想復盤一下，所以有了這篇文章。

分頁的目的

做個假設，加入用例庫有 1W 條數據，如果想要以列表形式展示，一次性返回 1W 條數據；這樣做有兩個弊端：

1.這樣寫出來的接口會慢。想一下如果隨著時間的發展，這個數量變成了 10W、100W 該怎麼辦？

2.對前端不友好。用前端渲染 1W 條數據，有理智的開發都不會這麼做。

所以，我們做分頁的目的，主要是為了性能的提高，提高使用體驗。

我這邊開發語言是Python，Web框架用的是 Tornado，後臺資料庫用的是 Mongodb。

接口設計

首先，我們做一下接口的設計，如下：

HTTP URL: /api/admin/v1/case/list

HTTP Method: GET

Request Params

Reponse Data

{

"code": 0,

"message": null,

"data": {

"cases": [

{

"method": str,

"url": str,

"request_data"?: str,

"request_params"?: str,

"header": dict,

"reponse_data"?: str

},

...

],

"count": int

}

}

返回數據結構解析：

cases 的值是包含多個 case 對象的列表；

count 指的是 case 的總數，這樣前端就可以通過 count 來判斷一共有多少頁，然後通過點擊的頁數直接請求到對應頁的數據做展示，這樣做可以有效地控制返回的數據量以及返回時間，提高用戶體驗感。

根據上述的接口約定，接口實現如下（僅展示關鍵代碼）：

class CaseList(APIHandler):

async def get_handler(self):

page = self.input.page or 1

limit = self.input.limit or 12

page, limit = int(page), int(limit)

skip = limit * (page - 1)

return {

'customers': await CaseService.get_case_list(filter_={}, skip=skip, limit=limit),

'count': await CaseService.get_count(filter_={})

}

接口解讀

下面我們逐行來解讀這個接口。

1.根據 API 約定，page和limit是不必傳且有默認值，所以獲取時可以直接寫為self.input.page or 1，其中當page不傳時self.input.page為None。

2.後端獲取到的GET請求的請求參數是String，所以需要int轉為整型，這裡直接int(page)即可，因為經過了前面的處理，page必然是有值的。

3.通過limit * (page - 1)，計算出跳過多少個；白話描述skip的作用就是，從第skip個對象開始，往後取limit個，返回。

4.get_case_list方法和get_count方法的filter_參數的值應該保持一致，因為他們都是對case這個對象做操作，只不過count是取總數而已。

CaseService.get_case_list方法

async def get_case_list(filter_: dict, skip: int = None, limit: int = None) -> Optional[List[dict]]:

""" 獲取 case 列表 """

sort = [('create_time', -1)]

if skip is not None and limit is not None:

ret = await cls.find('case', filter=filter_, sort=sort, limit=limit, skip=skip)

else:

ret = await cls.find('case', filter=filter_, sort=sort)

return ret

1.對skip和limit的空值判斷要用is not None，因為skip可能為，如果使用if skip來判斷，skip=0的時候也會進入分支。

2.sort = [(『create_time』, -1)]的傳入使返回的列表按照創建時間倒敘排列，如果你不做這個，相信負責人的測試同學會給你提一個「易用性問題」。

3.sort skip limit是有執行優先級的，他們優先級依次是sort→skip→limit，skip limit的優先級為skip→limit。

這裡大家不要去考慮pymogo執行的時候會不會對sort、skip、limit自動給按照優先級執行，傳參的時候按照優先級去傳參就好了，養成良好的習慣，不必糾結其他的。

CaseService.get_count方法

async def get_count(cls, filter_: dict) -> int:

""" 獲取 case 總數 """

return await ModelHandler.count('case', filter=filter_)

這裡用count來獲取數據，可以直接拿到總數，而不是取出list然後去求length，避免了內存空間的浪費。

以上，就是對列表接口進行分頁的整個過程啦，謝謝閱讀，這篇餵飯教程帶你熟悉了寫這個接口的整個過程及其中的細節，但具體的實現還需要大家動手去實踐。

請關注 私信回覆：「測試」 就可以免費拿到軟體測試學習資料。