英语是描述Web服务(Rest,SOAP等)的标准吗?

问题描述 投票:4回答:6

在我正在进行的当前项目中,我们讨论了我们应该用来描述路径名,字段,有效负载等的语言(英语或西班牙语)。

我认为这是一个容易的主题,但是,我找不到一个准确的来源,其中描述了英语应该是描述Webservice组件的标准。

例如,假设我们有一个非常简单的Rest API,用于创建用户的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的组件并不重要。

可能这是一个主要基于意见的问题,如果您认为是这样,请发表评论。

web-services architecture standards nomenclature code-standards
6个回答
5
投票

作为一名西班牙语母语人士,我认为没有任何技术理由可以用英语(事实上的技术语言)来编写API。

如果打算开发一个对西班牙语世界以外的人来说难以处理的API,我想这将是一种方法。

然而,我发现在讲西班牙语的软件项目中,这种情况一再发生。我认为这是有害的。

其他,让我们来看看日本最强大的科技公司之一乐天。 Rakuten决定强制执行英语作为所有员工的工作语言,尽管其大部分业务都在日本。

它告诉你一些事情。在全球连接的21世纪世界中,将您的产品瞄准最广泛的受众。

我不能想出这样做的公理理由(我会说“不要使用goto语句。”)但是用英语以外的任何东西写一些东西是我不会做的。


3
投票

我认为没有规范,但我只是说:用其他语言的人可以用很多方式使用你的代码。因此,坚持使用英语是让任何人都能理解和使用它的更好方法。


1
投票

我是一名在西班牙生活和工作的母语双语西班牙语 - 英语人士。在我的许多IT软件开发项目中,我发现自己在国际团队中与印度,法国和英国的人们合作。在这些场景中,用一种共同语言理解是明智的。另一方面,我也参与了客户只讲区域语言的项目,没有必要既不使用西班牙语也不使用英语。这取决于您的同事是谁以及您的最终用户是谁。


1
投票

使用另一种语言作为英语总是强制您替换您的语言的特殊字符,如口音和ñ等类似的东西。但这是可以解决的。

问题是:谁将使用您的服务?如果消费者不是西班牙语,他们肯定会喜欢英语。

但是,根据我的经验,您经常会有非常特定于域名的名称,有时无法将其正确翻译成英语,或者很难知道英语中的正确单词会是什么,因为翻译人员通常会为您的特定领域提供奇怪的翻译(西班牙语)。所以我看到很多Web服务被翻译成英文但我还是要问:这是什么意思?因为翻译没有意义。

因此,我的意见是使用西班牙语,除非您的Web服务实际上是在西班牙语世界之外使用的。因为如果它在西班牙语单词之外被消费,那么也可以获得良好的翻译。


1
投票

我是德语母语人士,我的工作语言大多是英语(在美国公司工作),绝对是编码时。我基本上把我所有的专业软件都设置为英文,我甚至不得不说当我用德语看到它时我会感到困惑;-)所以我的观点是,从我的日常例行观点来看,我不会甚至考虑使用我的母语进行编码。

但是,在更一般的层面上,我想争辩说应该以这样的方式创建API,使得消费者可以轻松地从端点判断它应该做什么。正如上面其他一些人所述,我认为最终会考虑谁是消费者是值得的。如果你有一个封闭的目标受众,所有人都说同一种语言,没有计划在外部公开API,那么我可以想象用该语言制作端点标签。

还有两点值得考虑: - 你能确定所有(未来)开发人员都会说这种语言而且不应该让他们感到困惑吗? - 如何为API端点提供两种语言的标签?根据您使用的编程语言/框架,我认为复制端点可能非常简单,但调用相同的逻辑。我不确定这是不是很好的做法,但如果对消费者有利,而你仍然希望坚持使用工作语言以保证安全,我可以想象这一点。


1
投票

我想如果您的团队(以及您项目/公司的未来开发人员)和客户都是西班牙语,您可以根据需要使用英语或西班牙语。但是,如果您认为非西班牙语的发言者会在任何时候编写或使用您的API,您应该使用英语。

© www.soinside.com 2019 - 2024. All rights reserved.