REST API URI设计

Question

我需要开发一个REST API，我对URI设计有疑问。

情境：

1 - 我正在为一组服务开发一个REST接口。

2 - 每个服务在逻辑上分为几个部分（不是资源）。

3 - 每种资源都可以通过两种方式访问​​“A”和“B”

最合适的URI设计是什么：

/服务1 / part1的/资源{A | B}？

/服务1，part1的，资源{A | B}？

Answer 1

虽然任何一种URL结构都可以使用，但是您列出的选项/ service1 / part1 / resource？{A | B}更为典型，并且具有使用常见REST API消费工具的最高机会，可以直观地理解正斜杠的含义实际上是在URI标准（我认为是RFC 1630）中定义的，而相对URI只适用于正斜杠。

Answer 2

这个更好：

/service1/part1/resource?{A|B}

因为它强调层次结构（感谢斜线）。

此外，“访问资源的方式”通常使用HTTP谓词（例如GET，POST，PUT，DELETE，HEAD等）发音。如果你的意思是“方式”，那么你一定要坚持使用HTTP动词。