对于为多种语言设计的JSON客户端API，我应该使用什么命名约定？

Question

这是原始RPC客户端API规范的文档。规范中的命名约定是camel案例。

对于不同的语言(camel case与pascal case)，命名约定可能有细微的不同，但是对于一些惯例，如毒蛇案例(Python)或Swift的流畅使用API，更改原始规范中的名称可能会增加对已经熟悉该规范的人使用API时的认知负荷。

当在GitHub上搜索不同的JSON时，一些实现似乎利用反射拦截方法调用并按原样将它们传递给RPC请求，因此该语言的方法名称与原始规范中的方法名称相同。如果反射不可用，则名称是硬编码的，并且大部分与规范相同，只更改了某些语言的字母大写。

下面是一些例子：

在Swift中不使用Fluent设计

https://github.com/fanquake/CoreRPC/blob/master/Sources/CoreRPC/Blockchain.swift https://github.com/brunophilipe/SwiftRPC/blob/master/SwiftRPC/SwiftRPC+Requests.swift

在Ruby中不使用蛇壳

https://github.com/sinisterchipmunk/bitcoin-client/blob/master/lib/bitcoin-client/client.rb

在C#中将方法名改为pascal情况

https://github.com/cryptean/bitcoinlib/blob/master/src/BitcoinLib/Services/RpcServices/RpcService/RpcService.cs

Answer 1

你在这里的意思还不清楚。

您不能为多种语言编写客户机，也不能为X语言编写客户机，您应该遵循X语言的命名约定。

如果您正在编写api，则使用约定作为数据传输的格式。JSON通常会使用javascript惯例，即骆驼案例。

但这并不重要，因为每个人都将使用某种类型的客户机来访问您的api。他们永远不会看到你的名字