2009-02-21 55 views
3

我的一位同事正在爲PHP應用程序開發SOAP API,他在想如果CamelCaps名稱是SOAP方法的某種約定?駱駝帽SOAP方法名稱

我們當前的API具有lower_caps_and_underscores,但與其他SOAP API的隨機子集相比,它似乎有點奇怪,我們也不想用我們錯誤的慣例來惹惱API的消費者。

回答

2

在幾乎所有的標準SOAP API中,我都看到了CamelCaps。你可能想看看標準的SOAP API。即谷歌的SOAP API api

我認爲如此Underscore可能會惹惱用戶。你可以關注其中的任何一個,但更重要的是遵循任何單一的標準命名約定。

爲命名服務需要考慮的另一件重要事情是,命名應該明確地確定某個服務在特定環境中的含義和上下文。

GetCustomerHistoryById =度日ID單一客戶歷史
GetCustomersHistory =獲取所有客戶的歷史

1

你開發什麼語言(這不是問題)?

根據我的經驗,lower_with_underscores似乎是PHP開發的首選樣式,但CamelCase似乎更普遍使用。

只是一個想法

0

對於SOAP,您看到Pascal大小寫或駱駝套管。 SOAP名稱空間是Pascal Cased(soap:Envelope any)。我猜你用什麼取決於你畫線的地方。

一般來說,我使用Pascal Casing的方法和屬性。這兩個要素體現了合同的框架。考慮到這一點,我可能會有與Methods和Properties Pascal Cased相對應的SOAP元素。

至於參數和返回值,我將不得不考慮打破帕斯卡套管規則,並在那裏使用駱駝套管。 Fortunatley,我現在沒有建立一個SOAP API,所以我有時間思考它。

但是,我不會用Pascal或Camel外殼以外的東西,因爲它是非標準的。不是我認爲人們會說「我沒有使用您的API,因爲它使用非標準的命名」,但只是按照慣例。但是,那些違背慣例的人們往往會提出下一個新的發展趨勢。 ;-)