REST多端点设计

Question

我目前正在构建一个.NET Web，它将在仪表板的另一个项目中使用。当前，第一个端点返回为给定日期范围发送的包裹总数和包数组。

这个API端点响应的示例如下所示

{
    "totalCount": 3,
    "data": [
        {
            "parcelId": 1,
            "parcelSentDate": "2022-04-25",
            "parcelCount": 1
        },
        {
            "parcelId": 2,
            "parcelSentDate": "2022-04-26",
            "parcelCount": 1
        },
        {
            "parcelId": 3,
            "parcelSentDate": "2022-04-27",
            "parcelCount": 1
        }
    ],
    "success": true
}

第二个端点返回包裹的总数，这些包裹是早交付的、晚交付的还是按时交付的，并且有一个包含交付日期和估计交付日期的包裹数组。

这个API端点响应的示例如下所示

{
    "early": 1,
    "late": 2,
    "onTime": 0,
    "data": [
        {
            "parcelId": 1,
            "deliveredDate": "2022-05-04",
            "estimatedDeliveryDate": "2022-05-02",
        },
        {
            "parcelId": 2,
            "deliveredDate": "2022-05-01",
            "estimatedDeliveryDate": "2022-04-30",
        },
        {
            "parcelId": 3,
            "deliveredDate": "2021-05-26",
            "estimatedDeliveryDate": "2022-05-09",
        }
    ],
    "success": true
}

可以使用parcels数组的第二个端点计算发送的包总数。我想知道的是，仍然可以保留返回发送的包裹总数的第一个端点，并将其分开吗？还是只保留第二个端点并从它导出整个包计数更好，因为它将包含所有的包信息？

这一切都取决于形势，这里没有一个正确或错误的答案吗？

Answer 1

您只能保留一个端点，但可以使用任何特定参数(如早期、延迟或根据业务需求而定)进行分离。如果这些参数传递，则返回第二个端点功能或只返回第一个端点功能。如果不需要这些参数，只需放置一个参数(如with_specifications = true )，然后返回第二个端点功能，否则，如果为false，则返回第一个端点功能。