имена следуют за нами повсюду, поэтому важно выбирать великие имена.
Почему имена имеют значение?
- без имени он в лучшем случае нечитаем.
- нам нужно очень тщательно обдумать имя, которое мы выбираем для API.
- «Разве мы не можем просто изменить имена, если они окажутся неудачными?» — Да, но очень тяжело.
- Изменение общедоступных имен в API немного похоже на изменение вашего номера телефона.
Что делает имя «хорошим»?
- предотвратить путаницу пользователей, например. «model_topic», «messaging_topic» вместо «topic».
- имена должны быть выразительными, но не чрезмерно длинными.
- «Тема» достаточно хороша, когда мы касаемся только одной области, такой как обмен сообщениями, в то время как «messaging_topic» не добавит большой ценности.
хорошо — транзакции
/accounts/{account_id}/transactions— этот ресурс позволяет пользователю просматривать список всех транзакций, совершенных на определенной учетной записи./accounts/{account_id}/transactions/{transaction_id}— этот ресурс позволяет пользователю просматривать детали конкретной транзакции./accounts/{account_id}/transactions/transfer- Этот ресурс позволяет пользователю совершать переводы между аккаунтами.
запутанно — trans, tran_details, money_transfer
/accounts/{account_id}/trans— этот ресурс позволяет пользователю просматривать список всех транзакций, совершенных на определенной учетной записи./accounts/{account_id}/tran_details/{transaction_id}— этот ресурс позволяет пользователю просматривать детали конкретной транзакции./accounts/{account_id}/money_transfer- Этот ресурс позволяет пользователю совершать переводы между аккаунтами.
