Trait d'union, un trait de soulignement ou camelCase comme délimiteurs de mot dans les Uri?

Je suis de la conception d'un réseau HTTP API pour un intranet d'application. Je me rends compte que c'est un joli petit souci dans le grand schéma des choses, mais: dois-je utiliser des traits d'union, des traits de soulignement, ou camelCase pour séparer les mots dans les Uri?

Voici mes premières impressions:

camelCase

  • problèmes possibles si le serveur est insensible à la casse
  • semble avoir assez large utilisation dans la chaîne de requête de touches (http://api.example.com?a=...), mais pas dans d'autres URI pièces

Trait d'union

  • plus esthétique que les autres solutions
  • semble être largement utilisé dans la partie du chemin d'accès de l'URI
  • jamais vu un trait d'union de la chaîne de requête de la clé dans la nature
  • éventuellement mieux pour le RÉFÉRENCEMENT (ce peut être un mythe)

Trait de soulignement

  • potentiellement plus facile pour les langages de programmation pour gérer
  • plusieurs Api (Facebook, Netflix, StackExchange, etc.) utilisez des caractères de soulignement dans toutes les parties de l'URI.

Je suis penchée vers souligne de tout. Le fait que la plupart des gros joueurs sont l'utilisation, est convaincant (voir https://stackoverflow.com/a/608458/360570).

  • De tout ce que j'ai lu, vous devez utiliser des traits d'union, mais des traits de soulignement semble plus facile à gérer.
  • Pourquoi?
  • Je crois que des traits d'union ont été, à un moment, le mieux pour les fins de SEO. Cela pourrait ne pas être vrai aujourd'hui, mais beaucoup de gens l'ont adopté, il est de plus en plus largement accepté comme une meilleure pratique. des traits de Soulignement d'autre part, peut-être plus facile à traiter dans le backend de programmation. J'utilise le PHP, il est donc beaucoup plus facile d'utiliser un trait de soulignement pour un nom de fonction qu'un trait d'union. camelCase peut-être le plus facile à mettre en œuvre, mais la lecture, il est souvent difficile. Enfin, je pense que vous avez raison quand vous avez dit que vous ne verrez jamais un hyphenated query string in the wild. C'est généralement un temps pour camelCase.
  • Conformément à cette question, le trait de soulignement n'est pas une option valide: stackoverflow.com/questions/3641722/...
  • Double Possible de il y a aucune convention de nommage des lignes directrices pour l'Api REST?
  • Vous mentionnez populaire Api, j'aimerais ajouter un: Google. Autant que je l'ai vu, Google utilise rien du tout entre les mots (vérifier les Cartes Google maps Matrice de Distance de l'API par exemple).

InformationsquelleAutor Josh Johnson | 2012-04-24
  1. 383

    Vous devez utiliser des traits d'union dans un crawlable URL de l'application web. Pourquoi? Parce que le trait d'union sépare les mots (de sorte qu'un moteur de recherche peuvent indexer les mots individuels), et n'est pas un caractère de mot. Trait de soulignement est un caractère de mot, le sens qu'il devrait être considéré comme faisant partie d'un mot.

    Double-cliquez sur ce dans Chrome: camelCase

    Double-cliquez sur ce dans Chrome: under_score

    Double-cliquez sur ce dans Chrome: trait d'union-auf s i indiqué

    Voir comment Chrome (j'entends Google fait un moteur de recherche, de trop) ne pense qu'un de ces deux mots?

    camelCase et underscore demande à l'utilisateur d'utiliser le maj clé, alors que hyphenated ne le fait pas.

    Donc, si vous devez utiliser des traits d'union dans un crawlable application web, pourquoi vous la peine de faire quelque chose de différent dans une application intranet? Une chose de moins à retenir.

    • Mon Firefox 24 sur Windows 7 pense "trait d'union-auf s i indiqué' est deux mots.
    • et il se comporte de la même pour la "under_score'.
    • une convention pour la chaîne de requête, par exemple ?event_id=1 ou ?eventId=1???
    • Même si les Url sont sensibles à la casse, la meilleure pratique consiste à utiliser des minuscules dans la mesure du possible, qu'il supprime la possibilité d'erreur de frappe.
    • aussi, je laisserais tomber le terme id le nom du paramètre et juste event=1
    • Certains mots peuvent être un trait d'union (en anglais): grammarbook.com/punctuation/hyphens.asp N'est-ce pas mieux souligne à cet égard?
    • Interactif de réponse 🙂

    InformationsquelleAutor Neil McGuigan
  2. 163

    La norme de meilleure pratique pour les Api REST est d'avoir un trait d'union, pas camelcase ou des traits de soulignement.

    Cela vient de la Marque de Masse "de l'API REST de Conception Rulebook" de Oreilly.

    En outre, noter que le Dépassement de la Pile elle-même utilise des traits d'union dans l'URL: .../hyphen-underscore-or-camelcase-as-word-delimiter-in-uris

    Comme WordPress: http://inventwithpython.com/blog/2012/03/18/how-much-math-do-i-need-to-know-to-program-not-that-much-actually

    • Si vous regardez le chapitre sur la chaîne de requête de lignes directrices dans le RESTE de l'API Conception du Livret de règles, vous remarquerez que les lignes directrices varient selon la règle de la partie. Il n'y a pas de règle explicite sur les caissons dans les chaînes de requête, mais vous verrez que tous les exemples dans la section sur les chaînes de requête que toutes les touches sont en chameau cas.
    InformationsquelleAutor Al Sweigart
  3. 25

    Tandis que je recommande traits d'union, je vais aussi postuler une réponse qui n'est pas sur votre liste:

    Rien Du Tout

    • De ma société API a des URIs comme /quotationrequests/, /purchaseorders/ et ainsi de suite.
    • En dépit de vous dire que c'était une application intranet, vous avez énumérés SEO comme un avantage. Google ne correspond pas au modèle /foobar/dans l'URL d'une requête de ?q=foo+bar
    • Je vraiment espère ne pas envisager l'exécution d'un appel PHP à n'importe quelle chaîne de caractères que l'utilisateur a réussi dans la barre d'adresse, comme @ServAce85 suggère!
    • Aléatoire des électeurs: le Soin d'expliquer ce qui est mauvais à propos de cette réponse? Je vais améliorer où je peux, ou, êtes-vous juste en bas de droit de vote parce que vous êtes en désaccord avec elle?
    • +1 pour le pointage d'un choix évident. Il a également disambiguates /quotationrequests/ de /offres/demandes/.
    • Ce qui est mauvais sur cette réponse, c'est que, d'un point de vue SEO, il n'y a aucun moyen pour une machine de comprendre où un mot se termine et une autre commence, de sorte que cette information est perdue. Il est également difficile pour les lecteurs ainsi. Il est préférable d'avoir quelques mots de séparateurs que rien.
    • SEO n'est pas pertinent, comme c'est une application intranet derrière un journal dans le mur.
    • Je suis d'accord avec @niel-mcguigan que même si c'est un intranet application, si vous utilisez des traits d'union partout c'est une chose de moins à retenir.
    • Juste assez. Mais notez que j'ai dit "postulat" pas de "recommander" 🙂 Et en général, le domaine n'ont pas de traits d'union dans les, afin de les utiliser dans des chemins est déjà plus qu'une chose à se rappeler.
    • Autant que je l'ai vu, Google utilise cette solution dans leur Api (vérifier l'API Google Maps par exemple)

    InformationsquelleAutor Nicholas Shanks
  4. 16

    En général, il ne va pas avoir assez d'impact pour inquiéter, en particulier puisque c'est un intranet application et non d'une utilisation générale d'Internet app. En particulier, puisque c'est intranet, le RÉFÉRENCEMENT n'est pas une préoccupation, depuis votre intranet ne doit pas être accessible aux moteurs de recherche. (et si elle l'est, elle n'est pas une application intranet).

    Et de tout cadre vaut son sel soit déjà a défaut de ce faire, ou est assez facile de changer la façon de traiter avec multi-parole URL composants, donc il ne faut pas s'inquiéter trop.

    Cela dit, voici comment je vois les différentes options:

    Trait d'union

    • Le plus grand danger pour les traits d'union, c'est que le même personnage (généralement) est également utilisé pour la soustraction numérique et de la négation (c'est à dire. moins ou négatif).
    • Des traits d'union sentir maladroit dans l'URL de composants. Ils semblent n'ont de sens à la fin d'une URL pour séparer les mots dans le titre d'un article. Ou, par exemple, le titre d'un Débordement de Pile question qui est ajouté à la fin d'une URL pour le RÉFÉRENCEMENT et l'utilisateur des raisons de clarté.

    Trait de soulignement

    • De nouveau, ils se sentent mal dans l'URL de composants. Ils cassent le débit (et de la beauté/de la simplicité) d'une URL, car ils sont essentiellement ajouter un grand, lourd apparente de l'espace au moyen d'un chiffon propre, fluide URL.
    • Ils ont tendance à se fondre avec souligne. Si vous pensez que vos utilisateurs à copier-coller l'Url dans MS Word ou autre texte similaire, les programmes de montage, ou n'importe où d'autre qui pourrait ramasser sur une URL et le style avec un trait de soulignement (comme des liens traditionnellement sont), alors vous voudrez peut-être éviter traits de soulignement comme des séparateurs de mots. En particulier lors de l'impression, souligné URL avec des traits de soulignement a tendance à regarder comme il a espaces dans ce lieu de souligne.

    CamelCase

    • De loin mon préféré, car il rend l'Url semble une meilleure circulation et n'a aucun des défauts que les deux options précédentes n'.
    • Peut être légèrement plus difficile à lire pour les gens qui ont un moment difficile différencier les majuscules de bas-de-casse, mais cela ne devrait pas être un problème dans une URL, parce que la plupart des "mots" doit être l'URL de composants et séparés par un / de toute façon. Si vous trouvez que vous avez un composant de l'URL qui est de plus de 2 "mots", vous devriez probablement essayer de trouver un meilleur nom pour ce concept.
    • Il ne ont un problème possible avec de la casse, mais la plupart des plates-formes peut être ajustée soit sensible ou non sensible à la casse. Tout c'est seulement vraiment un problème pour les 2 cas de figure: un.) l'homme tapant l'URL dans, et (b).) Les programmeurs (comme nous ne sommes pas humains) en tapant l'URL dans. Les fautes de frappe sont toujours un problème, indépendamment de la casse, donc ce n'est pas différent que tout un cas.
    • En désaccord. Regarder regardez tous les sites wordpress, regardez la plupart des sites de nouvelles, ils utilisent tous des traits d'union. Aussi camel cas des mélanges cas, le web devrait être en bas de casse, à mon avis.
    • À mon avis, le web devrait être sensible à la casse, en fait. Quant à la convention, si vous suivez RoR (ruby on rails) les voies d'approche, vous pouvez utiliser des caractères de soulignement. Habituellement, je le fais à assurer sa cohérence à travers les rails de routes générées et mes routes nommées. Néanmoins, je pense que pour moi dash lisent mieux que les traits de soulignement.
    • Peut-être qu'ils ont un moteur de recherche interne dans leur intranet?
    • En désaccord. Deux de vos arguments contre les traits d'union sont imparfaits. Il n'y a pas de danger sur la négation ou la soustraction parce que nous parlons de la partie du nom d'un tuple ici, vous ne devriez jamais être le fonctionnement ou l'évaluation de la partie du nom d'un tuple pour les mathématiques ou la négation. Il n'y a rien de maladroit sur l'utilisation des traits d'union dans les Uri comme c'est depuis longtemps une des meilleures pratiques utilisées par une pénurie de sites. De plus, elles ne nécessitent pas de frapper la touche Maj enfoncée et sont traités comme des limites de mots par pratiquement tout le monde.
    • D'aussi loin que je me souvienne, les traits d'union ont été fortement utilisés norme dans les URL, et il est vraiment considéré comme la meilleure pratique dans les normes d'aujourd'hui. Ne les utilisez pas, parce que le impression maladroit semble gênant pour moi.
    InformationsquelleAutor cdeszaq
  5. 0

    voici le meilleur des deux mondes.

    J'ai aussi "comme le met en évidence, en plus de tous vos points positifs à leur sujet, il y a aussi un certain style old-school pour eux.

    Donc ce que je fais est d'utiliser des caractères de soulignement et simplement ajouter une petite règle de réécriture à votre Apache .fichier htaccess pour ré-écrire tous les caractères de soulignement pour les traits d'union.

    https://yoast.com/apache-rewrite-dash-underscore/

    InformationsquelleAutor user2597538