用于获取具有2个输入参数的数据的休止端点 - 获取的类型是显式还是隐式确定?

时间:2018-04-03 02:17:27

标签: rest web api-design

我正在建立一个端点,让我们称之为/explore,其中可以通过两种方式请求数据:

  1. 根据需要提供lat,lng个参数和一些可选/默认参数,以查找某个位置的特定距离内的结果。这对于可能显示结果列表视图的客户端非常有用。

  2. 根据需要提供一个边界框NE lat,lngSW lat,lng,以便在该区域内查找结果。这对使用地图视图的客户非常有用。

  3. 在这种情况下,什么被认为是更好的做法?

    API使用者是否应该提供明确的type=maptype=list,或者我应该让开发人员允许使用者传递边界框或latLng对,​​并根据输入确定要发回的内容?

    由于

1 个答案:

答案 0 :(得分:1)

我会根据是否传递单个坐标或边界框来决定。这可以防止类型等于边界框的一类错误,但只传入一个坐标(反之亦然)

下面列表中的第一个请求将返回一个列表,其中第二个请求将返回边界框。

<div class="mainDiv">
  <div class="box"></div>
  <div class="text">text</div>
</div>