“辅助”表的 Restful 资源命名答案

【问题标题】：Restful resource naming for "secondary" tables“辅助”表的 Restful 资源命名
【发布时间】：2016-11-08 02:46:07
【问题描述】：

让我们以我的示例为例，我有 3 个表，我想知道命名资源 url 的最佳方法是什么。

表格：

建筑
building_type 最简单的定义是#1。

API 资源：

GET someapi.com/buildings
GET someapi.com/**?**

我的问题是我不知道像 building_type 这样的“辅助表”的最佳做法是什么。

也许：

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

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

【问题讨论】：

您真的需要公开建筑类型列表吗？如果您只需要显示建筑物的类型，通过 Building 资源上的 Type 属性公开它应该没问题
这就是我需要帮助的原因。在我的脑海里，我有暴露一切的需要。例如，如果我想在页面上显示所有建筑类型及其属性，我需要公开该资源，不是吗？

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

【解决方案1】：

您首先需要弄清楚我们对您的 API、场景、用例等的要求，然后才能真正开始构建它。

回到你的问题，我会选择GET someapi.com/buildingTypes，因为/buildings/types 会给你留下一个“类型”资源，它本身没有多大意义。你确实可以让它只有在你访问建筑物资源后才能访问，所以GET someapi.com/buildings/buildingTypes 可能是navigate 的方式。

【讨论】：