关于接口设计的问题

有一个商品信息的接口:
api/goods/<goods_id>/

每个商品都有一条关联的追溯信息(与商品主键关联),对于追溯信息的接口应该怎么设计比较好?
我想到的情况:

  1. 第一种:api/tracebacks/?goods=<goods_id>

    这种写法我是用过的,但是感觉语义不明确,每个商品的追溯信息有且仅有一条的,使用查询多条数据的接口形式,感觉很不合适
  2. 第二种:api/goods/<goods_id>/traceback/

    这种不知道是否规范
阅读 2.2k
2 个回答

看实际的情况。

第一种应该是/api/traceback?good=<good_id>
当有一个traceback集中化的系统,以此为中心时,可以使用这种方式。good作为查询条件,以后还能扩展其他查询条件。

第二种/api/good/<good_id>/traceback
如果只是针对每个goodtrackback,那么应当使用这种形式。

其他的形式

/api/traceback/good/<good_id>
此种情况和第一种类似,但只能查询单条件。当然,可以扩展成/api/traceback/good/<good_id>/order/<order_id>这样的,但是从语义上就有资源重要性的先后关系。


插一句,单条资源应该都是单数形式,如good;只有列表时才用复数,如/api/goods

api/tracebacks/goods/<goods_id>

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进