Я наконец начинаю понимать Мартина Фаулера, когда он сказал, что в информатике есть только две вещи.Одна из этих двух вещей - именование вещей .
Итак, на полпути к созданию API отдыха JSON я заметил, что не могу получить согласованную терминологию в API остальных.
ДляНапример, вы можете определить страну разными способами.Вы можете использовать название страны, двухбуквенный код страны iso, трехбуквенный код страны iso, официальное название и т. Д.
Так что вместо
{
"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"
}
Так что мой вопрос о значениях внешнего ключа, должен ли я использовать общее имя, такое как «страна»"или я должен быть очень конкретным, какую информацию я предоставляю для этого элемента?