接口设计-查列表和查详情分2个接口

  • 查列表:只要查询条件不带元素id都视为查列表(元素id:查询结果列表中每条数据)
  • 查详情:只要查询条件带元素id都视为查详情

查列表和查详情如果合成一个接口,会有什么问题呢?
查列表的同时组装查询出的每个元素的详情,会导致接口RT增加,此时相当于开了个批量处理的接口

查列表接口应该返回哪些字段:1.元素id(必须返)2.接口入参中的字段

查详情接口入参只要一个元素id就行,出参需要包含查列表接口出参所有字段

接口出参设计

要做到公共参数和业务参数分开,方便使用方封装client,使用方只想要业务参数,可以做个client统一处理公共参数
例如分页查询出参

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

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

        ]
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 第一部分 Python基础篇(80题) 1、为什么学习Python? Python相对于其他编程语言有很多优点: ...
    清清子衿木子水心阅读 1,867评论 0 1
  • Catalog 1 怎么解决OOM?/ 怎么排查OOM?/ JVM调优1.1 JDK自带工具1.2 阿里开源JVM...
    allen锅阅读 578评论 0 1
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 14,452评论 2 59
  • 1.软件测试级别? 单元测试:单元测试是对软件组成单元进行测试。其目的是检验软件基本组成单位的正确性。测试的对象是...
    听闻白依阅读 1,669评论 0 9
  • 1.StringBuffer与String的区别 StringBuffer是线程安全的,每次操作字符串,Strin...
    zdd5457阅读 1,141评论 0 5

友情链接更多精彩内容