接口設計-查列表和查詳情分2個接口

  • 查列表:只要查詢條件不帶元素id都視為查列表(元素id:查詢結(jié)果列表中每條數(shù)據(jù))
  • 查詳情:只要查詢條件帶元素id都視為查詳情

查列表和查詳情如果合成一個接口,會有什么問題呢?
查列表的同時組裝查詢出的每個元素的詳情,會導致接口RT增加,此時相當于開了個批量處理的接口

查列表接口應該返回哪些字段:1.元素id(必須返)2.接口入?yún)⒅械淖侄?/p>

查詳情接口入?yún)⒅灰粋€元素id就行,出參需要包含查列表接口出參所有字段

接口出參設計

要做到公共參數(shù)和業(yè)務參數(shù)分開,方便使用方封裝client,使用方只想要業(yè)務參數(shù),可以做個client統(tǒng)一處理公共參數(shù)
例如分頁查詢出參

  • 正例
{
    "success":true,
    "errorMsg":"xx",
    "data":{
        "page":1,
        "pageSize":10,
        "total":215,
        "list":[

        ]
    }
}
  • 反例
{
    "success":true,
    "errorMsg":"xx",
    "total":215,
    "data":{
        "page":1,
        "pageSize":10,
        "list":[

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

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

  • 第一部分 Python基礎篇(80題) 1、為什么學習Python? Python相對于其他編程語言有很多優(yōu)點: ...
    清清子衿木子水心閱讀 1,828評論 0 1
  • Catalog 1 怎么解決OOM?/ 怎么排查OOM?/ JVM調(diào)優(yōu)1.1 JDK自帶工具1.2 阿里開源JVM...
    allen鍋閱讀 548評論 0 1
  • 用兩張圖告訴你,為什么你的 App 會卡頓? - Android - 掘金 Cover 有什么料? 從這篇文章中你...
    hw1212閱讀 14,096評論 2 59
  • 1.軟件測試級別? 單元測試:單元測試是對軟件組成單元進行測試。其目的是檢驗軟件基本組成單位的正確性。測試的對象是...
    聽聞白依閱讀 1,633評論 0 9
  • 1.StringBuffer與String的區(qū)別 StringBuffer是線程安全的,每次操作字符串,Strin...
    zdd5457閱讀 1,122評論 0 5

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