2009-02-21 3 views
3

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

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

ответ

2

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

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

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

т.е.

GetCustomerHistoryById = Get одной истории клиентов по идентификатору
GetCustomersHistory = Get история все клиента

1

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

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

Просто мысли

0

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

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

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

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

Смежные вопросы