2009-02-21 5 views
3

Un de mes collègues développe l'API SOAP pour l'application php et il se demande si les noms CamelCaps sont une sorte de convention pour les méthodes SOAP? Notre API actuelle a lower_caps_and_underscores, mais elle semble quelque peu étrange comparée à un sous-ensemble aléatoire d'autres API SOAP, et nous ne voulons pas vraiment ennuyer les consommateurs d'API avec notre mauvaise convention.Camel Caps noms de méthodes SOAP

Répondre

2

Dans presque toutes les API SOAP standard, j'ai vu, avait CamelCaps. Vous voudrez peut-être regarder l'API SOAP standard. c'est-à-dire google SOAP api

Je pense que Underscore peut ennuyer les utilisateurs. Vous pouvez suivre l'un ou l'autre, mais le plus important est de suivre les conventions de nommage standard.

Autre chose importante à considérer pour nommer un service, le nommage devrait clairement établir une signification et un contexte de ce que le service fera dans un contexte particulier.

à savoir

GetCustomerHistoryById = Obtenir une histoire unique de clients par id =
GetCustomersHistory Obtenez tous l'histoire du client

1

Quelle langue que vous développez en (pas qu'il importe)? D'après mon expérience, lower_with_underscores semble être le style préféré pour le développement PHP, mais CamelCase semble être plus généralement utilisé.

Juste une pensée

0

Pour SOAP, vous voyez soit Pascal Boîtier ou Camel boîtier. L'espace de noms SOAP est Pascal Cased (soap: Envelope anyone). Je suppose que ce que vous utilisez dépend de l'endroit où vous tracez la ligne.

En général, j'utilise Pascal Casing pour les méthodes et les propriétés. Ces deux éléments incarnent le cadre du contrat. Gardant cela à l'esprit, j'aurais probablement des éléments SOAP qui correspondent aux méthodes et propriétés Pascal Cased. En ce qui concerne les paramètres et les valeurs de retour, je devrais penser à casser la règle de casse de Pascal et à utiliser l'enveloppe de chameau là. Fortunatley, je ne construis pas une API SOAP en ce moment, donc j'ai le temps d'y réfléchir.

Je n'irais pas avec quelque chose en dehors du boîtier Pascal ou Camel, car il est non standard. Pas que je pense que les gens diraient "Je n'utilise pas votre API parce qu'il utilise une dénomination non standard", mais juste par convention. Mais, alors, les gens qui refusent la convention arrivent souvent avec la nouvelle tendance suivante dans le développement. ;-)

Questions connexes