Api Url零件命名法

问题描述 投票:0回答:1

我有一个api喜欢

http://api.mycompany.com/products/bycategory/{category_id}

/products/bycategory/{category_id}的结尾部分是如何命名的?如果我删除域部分,如果我把它放在web.config中,我如何命名其余部分?

URI?我查看了一些文章,但我很困惑。有时,完整的Url似乎是其他提到的剩余部分的URI。

谢谢。

api naming
1个回答
0
投票

URL由以下部分组成:

  • 协议,例如,http://
  • 域名,例如api.mycompany.com
  • 路径,例如,/products/bycategory/{category_id}
  • 可能是查询字符串,例如?key=value&otherKey=otherValue

由服务器决定如何解释路径和查询字符串。简单的Web服务器可能只提供路径指向的文件。应用程序服务器可以将该路径解释为查询。

REST resource naming guide谈论“资源”,这是有道理的,因为首先一个URL是一个uniform resource identifier(URI)。 URI也使用术语“路径”。

请参阅this question on REST API naming guidelines及其答案,这里使用的术语也是“路径”。

我也用“路径”。

© www.soinside.com 2019 - 2024. All rights reserved.