如果我有 user/{id}/resource 并且我想下载我的特定资源,我将如何正确命名端点?
user/{id}/resource/download 没有遵循 restful 设计模式,那么拥有 user/{id}/resourcedownload 并没有描述正确的资源?
我认为您对 API 命名模式应该如何工作感到有些困惑。当您在 URL 中指定 ID 时,您正在请求一个资源。该 ID 的资源。为了使这一点有意义,因为我不知道您的数据库结构,我们将使用电影作为示例。
如果您想获得所有电影的列表,您应该使用类似/api/movies
. 如果你想要一部特定的电影,你会使用类似/api/movies/{id}
.
其他资源也是如此。如果您想要所有演员的列表,您可以使用类似/api/actors
. 如果你想要一个特定的演员,你会使用像/api/actors/{id}
. 如果你想要一个演员出演的所有电影的列表,你可以使用类似的东西/api/actors/{id}/movies
,或者如果你想要一个演员出演的特定电影:/api/actors/{actorId}/movies/{movieId}
或者只是简单的/api/movies/{id}
。
请记住,这是为了让您了解命名约定而过于简化。如果是真正的API,您可能还有其他信息,例如分页和偏移量等...
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句