Является ли английский язык стандартом для описания веб-сервиса (Rest, SOAP и т. Д.)? - PullRequest
0 голосов
/ 31 января 2019

В текущем проекте, над которым я работаю, у нас было обсуждение языка (английский или испанский), который мы должны использовать для описания путей, полей, полезных нагрузок и т. Д.

Я думал, что это былЛегкая тема, однако, я не смог найти точный источник, где описано, что английский должен быть стандартом для описания компонентов Webservice.

Например, предположим, что у нас есть API Rest очень простой с CRUD длясоздание пользователей

английский

POST /v1/users

GET /v1/users/{uid}

DELETE /v1/users/{uid}

PUT /v1/users/{uid}

Испанский

POST /v1/usuarios

GET/v1/usuarios/{uid}

DELETE /v1/usuarios/{uid}

PUT /v1/usuarios/{uid}

Я думаю, что это не проблема, однако я хочу понять, если мне нужноследовать стандарту или, если неважно, какой язык я использую для описания компонентов Webservice.

Возможно, это вопрос, основанный прежде всего на мнениях, яЕсли вы думаете, что это так, пожалуйста, просто напишите мне с комментарием.

Ответы [ 6 ]

0 голосов
/ 12 февраля 2019

Я думаю, что если ваша команда (и будущие разработчики в вашем проекте / компании) и клиент - говорящие на испанском языке, вы можете использовать английский или испанский как хотите.Но если вы думаете, что в любой момент не говорящий по-испански будет кодировать или использовать ваш API, вам следует использовать английский.

0 голосов
/ 12 февраля 2019

Я - носитель немецкого языка, и мой рабочий язык в основном английский (я работаю в американской компании), определенно, когда речь заходит о кодировании.У меня в основном все мое профессиональное программное обеспечение установлено на английском языке, и я даже должен сказать, что я запутался, когда увидел его на немецком языке ;-) Итак, моя точка зрения такова, что с моей повседневной точки зрения я бы не стал 'Даже не подумайте об использовании моего родного языка для кодирования.

Однако на более общем уровне я хотел бы утверждать, что API должен быть создан таким образом, чтобы потребитель мог легко сказать с конечной точки, называя егодолжен делать.Поэтому, как некоторые другие заявили выше, я думаю, что в конечном итоге стоит задуматься о том, кто является потребителем.Если у вас есть закрытая целевая аудитория, все говорят на одном языке, и не планируют выставлять API извне, то я вполне могу себе представить, что на этом языке должны быть метки конечных точек.

Еще два момента, которые стоит рассмотреть: - МожетВы уверены, что все (будущие) разработчики говорят на этом языке, и это не должно смущать их?- Как насчет обеспечения конечных точек API метками на обоих языках?В зависимости от языка / структуры программирования, которую вы используете, я думаю, может быть довольно просто дублировать конечные точки, но при этом вызывать одну и ту же логику.Я не уверен, что это хорошая практика, но если для потребителей есть польза, и вы все равно хотите придерживаться рабочего языка, чтобы быть в безопасности, я мог бы представить это.

0 голосов
/ 11 февраля 2019

Использование другого языка в качестве английского всегда заставляет вас заменять специальные символы вашего языка, такие как ударения и - и все в таком духе.Но это решаемо.

Вопрос в следующем: кто будет пользоваться вашим сервисом?Если потребители не говорят по-испански, они определенно ценят английский.

Однако, по моему опыту, у вас часто бывают очень специфичные для домена имена, которые иногда не могут быть должным образом переведены на английский, или трудно понять, каким будет правильное слово в английском, поскольку переводчики часто дают вам странныепереводы для ваших доменных (испанских) слов.Итак, я видел много Web-сервисов, которые были переведены на английский, но мне все равно пришлось спросить: что это значит?потому что перевод просто не имеет смысла.

Поэтому я считаю, что нужно использовать испанский, если ваш веб-сервис фактически не используется за пределами испаноязычного мира.Потому что, если он употребляется вне испаноязычного слова, хороший перевод также доступен.

0 голосов
/ 10 февраля 2019

Я являюсь носителем двуязычного испано-английского языка, живу и работаю в Испании.Во многих моих проектах по разработке программного обеспечения для ИТ я работаю в международных командах, сотрудничающих с людьми в Индии, Франции и Великобритании.В этих сценариях разумно понимать язык, общий для всех.С другой стороны, я также работал над проектами, в которых клиент говорил только на региональном языке, и не было необходимости использовать ни испанский, ни английский.Это действительно зависит от того, кто ваши коллеги и кто ваши конечные пользователи.

0 голосов
/ 31 января 2019

Будучи самим носителем испанского языка, я не вижу технических оснований для написания API на каком-либо другом языке, кроме английского, де-факто технического языка.

Если целью является разработка API, которое труднокто-нибудь за пределами испаноязычного мира, я думаю, это был бы путь.

Тем не менее, я вижу, что это происходит снова и снова среди испаноязычных программных проектов.Я думаю, что это вредно.

OTH, давайте посмотрим на Rakuten, одну из самых мощных технологических компаний в Японии.Rakuten решил использовать английский как рабочий язык для всех сотрудников, хотя основная часть его бизнеса находится в Японии.

Это вам кое-что говорит.В глобально связанном мире 21-го века нацеливайте свои продукты на самую широкую аудиторию.

Я не могу придумать аксиоматическую причину для этого (так, как я бы сказал, «не используйте операторы goto»).во всем, кроме английского, я бы не стал это делать.

0 голосов
/ 31 января 2019

Я не думаю, что есть норма, но я бы просто сказал: может быть много способов, как ваш код может быть использован людьми с другим языком.Таким образом, придерживаться английского языка - лучший способ сделать его понятным и полезным для всех.

...