美文网首页
接口设计-查列表和查详情分2个接口

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

作者: 张某某xyz | 来源:发表于2023-01-08 11:00 被阅读0次
  • 查列表:只要查询条件不带元素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":[

        ]
    }
}

相关文章

网友评论

      本文标题:接口设计-查列表和查详情分2个接口

      本文链接:https://www.haomeiwen.com/subject/chuecdtx.html