我的一位同事正在开发 PHP 应用程序的 SOAP API,他想知道 CamelCaps 名称是否是 SOAP 方法的某种约定?
我们目前的 API 有 lower_caps_and_underscores,但与其他 SOAP API 的随机子集相比,它似乎有些奇怪,我们真的不想用我们错误的约定来惹恼 API 的消费者。
在几乎所有的标准 SOAP API 中,我见过,都有 CamelCaps。你可能想看看标准的 SOAP API。即 google SOAP api
我认为 Underscore 可能会惹恼用户。您可以遵循其中任何一个,但更重要的是遵循任何单一的标准命名约定。
命名服务要考虑的其他重要事项是,命名应该清楚地确定服务在特定上下文中的含义和上下文。
即
GetCustomerHistoryById = 按 id 获取单个客户的历史记录
GetCustomersHistory = 获取所有客户的历史记录
你在开发什么语言(不重要)?
根据我的经验,lower_with_underscores 似乎是 PHP 开发的首选样式,但 CamelCase 似乎更常用。
只是一个想法
对于 SOAP,您会看到 Pascal Casing 或 Camel Casing。SOAP 命名空间是 Pascal Cased (soap:Envelope anyone)。我猜你用什么取决于你在哪里画线。
一般来说,我使用 Pascal Casing for Methods 和 Properties。这两个元素体现了合同的框架。考虑到这一点,我可能会有对应于 Methods 和 Properties Pascal Cased 的 SOAP 元素。
至于参数和返回值,我将不得不考虑打破 Pascal 套管规则并在那里使用骆驼套管。Fortunatley,我现在不是在构建 SOAP API,所以我有时间考虑它。
但是,我不会使用 Pascal 或 Camel 外壳之外的东西,因为它是非标准的。并不是说我认为人们会说“我没有使用你的 API,因为它使用非标准命名”,但只是作为惯例。但是,那么,那些违背惯例的人经常想出下一个新的发展趋势。;-)
本站系公益性非盈利分享网址,本文来自用户投稿,不代表边看边学立场,如若转载,请注明出处
评论列表(29条)