当马丁·福勒（Martin Fowler）说计算机科学领域只有两件事时，我终于开始意识到。这两件事之一是命名。
所以在创建json rest API的途中，我注意到我在rest api中无法获得一致的术语。
例如，您可以用许多不同的方式定义国家。您可以使用国家/地区名称，国家/地区iso两字母代码，国家/地区iso-3字母代码，官方名称等。
所以不要拥有
{
"country" : "FR"
}
最好拥有
{
"country_iso_2" : "FR"
}
我的理由是，当您使用
{
"country" : ....
}
这可以是名称，iso两字母代码，iso三字母代码，数字值，正式名称等。必须查看API文档才能查看“国家”代表的含义。
当然，当它是国家对象（如
）的一部分时，这不是问题{
"country_id" : 250,
"country_name": "France",
"country_iso_2": "FR"
.......
}
但是当您偶然发现它作为“外键”时，我可以这样称呼它，例如
{
"client_id": 3434343,
"country": "250"
}
所以我的问题是关于外键值，我应该使用诸如“国家”之类的通用名称，还是应该非常具体地说明我为该元素提供的信息是什么？