时间戳

首页 > 解决方案 > REST API - 命名端点的逻辑方法

rest - REST API - 命名端点的逻辑方法

问题描述

我想遵循最佳实践来实现 REST API。我想公开一个资源，我可以想出两种方法来作为端点。

我想让用户有机会收到某个活动的所有付款。

我可以公开/campaigns/{id}/payment它返回一个分页的付款列表，其中包含每个付款的所有数据（姓名、地址、日期......）。依次/campaign/{id}返回活动的所有数据（名称、描述...、数组，paymentId以及一个一个获取它们的路径）。

或者我可以暴露/payments/campaigns/{campaignsId}。

什么是最好的方法，为什么？

标签： restapi-design

解决方案

假设 REST 关心 URI 拼写是一种误解。

但是，我鼓励您在 API 的 URI 中采用一致的命名约定。使用复数名词表示引用集合并组织 URI 以表示层次结构的 URI 是一种常见的方法。

因此，对于您在问题中描述的情况，您可以使用它/campaigns/{id}/payments来识别您的资源。它标识特定活动的付款集合。

推荐阅读