При проектировании API с использованием русскоязычных аббревиатур, особенно в контексте российского правового поля, стоит учитывать несколько лучших практик и рекомендаций:
1. **Интуитивно понятные названия**: Использование аббревиатур, понятно отражающих их смысл, может значительно улучшить читаемость и удобство использования API. В данном случае, использование `inn` скорее соответствует общепринятой практике и будет более интуитивно понятным для разработчиков, работающих с российским законодательством.
2. **Консистентность**: Очень важно придерживаться одного стиля во всем API. Если вы выберете `inn`, убедитесь, что везде используется этот вариант для обозначения ИНН. Это снизит вероятность путаницы для разработчиков, которые будут использовать ваше API.
3. **Соответствие стандартам**: Если в вашем проекте уже используются какие-то стандарты (например, OpenAPI), постарайтесь придерживаться их. Иногда определённые аббревиатуры могут быть определены в таких стандартах или широко приняты в других API.
4. **Учитывайте целевую аудиторию**: Если ваше API будет использоваться в основном разработчиками из России, использование местных аббревиатур может быть более подходящим. Если же предполагается международное использование, можно рассмотреть использование универсальных аббревиатур, таких как `tin` (Tax Identification Number). В этом случае важно также документировать каждую аббревиатуру.
5. **Документация**: Четкая и доступная документация очень важна. В ней следует подробно разъяснить, какие аббревиатуры используются, их значения и контексты применения. Это особенно актуально, если вы решите использовать менее распространённые на международном уровне термины.
6. **Обратная связь от пользователей**: На ранних этапах разработки, получение обратной связи от целевой аудитории, пользователей и команд разработки может помочь понять, какие названия и аббревиатуры будут наиболее понятными и удобными в использовании.
7. **Уменьшение аббревиатур**: Там, где это возможно, используйте полные слова вместо аббревиатур. Например, вместо использования `inn` или `tin` рассмотрите возможность использования `taxIdentificationNumber`. Это может сделать ваш API более самодокументируемым.
8. **Тестирование на удобство**: Проводите тестирования с реальными пользователями вашего API, чтобы понять, насколько интуитивно понятны выбранные вами аббревиатуры.
В вашем случае, выбор между `inn` и `tin` может зависеть от того, в каком контексте будет использоваться API и кто будет его основной пользователь. Если основной акцент на российском рынке, то `inn` может быть предпочтительнее. Но если вы планируете международное использование, стоит учитывать более общепринятые термины.