为" secondary"提供宁静的资源命名表

时间:2016-11-08 02:46:07

标签: rest restful-architecture restful-url api-design

让我们举个例子,我有3个表,我想知道什么是命名我的资源网址的最佳方法。

表格

  1. 建筑
  2. building_type最简单的定义是#1。
  3. API资源

    1. GET someapi.com/buildings
    2. GET someapi.com/**?**
    3. 我的问题是我不知道"次要表"的最佳做法是什么?比如building_type。

      也许

      • GET someapi.com/buildings/types
      • GET someapi.com/building-types
      • ...

      我希望你们中的一些人能够启发我。感谢。

1 个答案:

答案 0 :(得分:1)

首先需要确定您的API,方案,用例等的要求,然后才真正开始构建它。

要回到你的问题,我会选择GET someapi.com/buildingTypes,因为/buildings/types会给你留下一个“类型”资源,这对你自己没有多大意义。你确实可以做到这一点,只有在你去建筑物资源后才能访问它,所以GET someapi.com/buildings/buildingTypes可能是通往navigate的方式。