Названия методов SOAP верблюжьих шапок

Question

Один из моих коллег разрабатывает SOAP API для приложения php, и ему интересно, являются ли имена CamelCaps своего рода соглашением для методов SOAP?

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

Answer 1

Почти во всех стандартных SOAP API, как я видел, были CamelCaps. Вы можете посмотреть стандартный SOAP API. то есть Google SOAP API

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

Другая важная вещь, которую следует учитывать при именовании службы, это то, что наименование должно четко определять значение и контекст того, что служба будет делать в конкретном контексте.

т.е.

GetCustomerHistoryById = Получить историю одного клиента по идентификатору
GetCustomersHistory = Получить всю историю клиента

Answer 2

На каком языке вы развиваете (не то, что это имеет значение)?

По моему опыту, lower_with_underscores является предпочтительным стилем для разработки PHP, но CamelCase, похоже, более широко используется.

Просто мысль

Answer 3

Для SOAP вы видите либо корпус Паскаля, либо корпус верблюда. Пространство имен SOAP - Pascal Cased (soap: Envelope Any). Я думаю, что вы используете, зависит от того, где вы проводите линию.

В общем, я использую Pascal Casing для методов и свойств. Эти два элемента воплощают рамки контракта. Имея это в виду, я бы, вероятно, имел элементы SOAP, которые соответствуют методам и свойствам Pascal Cased.

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

Я бы не стал выходить за пределы корпуса Паскаля или Верблюда, поскольку это не стандартно. Не то чтобы я думал, что люди скажут: «Я не использую ВАШ API, потому что он использует нестандартные имена», но просто по соглашению. Но тогда люди, которые отказываются от соглашения, часто придумывают следующую новую тенденцию в развитии. ; -)