Trait d'union, trait de soulignement ou camelCase comme délimiteur de mot dans les URI?

Je conçois une API basée sur HTTP pour une application intranet. Je me rends compte que c'est une assez petite préoccupation dans le grand schéma des choses, mais: dois-je utiliser des tirets, des traits de soulignement ou camelCase pour délimiter les mots dans les URI?

Voici mes premières réflexions:

affaire de chameau

• problèmes possibles si le serveur ne respecte pas la casse
• semble avoir une utilisation assez répandue dans les clés de chaîne de requête ( http://api.example.com ? searchQuery = ...), mais pas dans d'autres parties URI

Trait d'union

• plus esthétique que les autres alternatives
• semble être largement utilisé dans la partie chemin de l'URI
• clé de chaîne de requête avec un trait d'union dans la nature
• peut-être mieux pour le référencement (cela peut être un mythe)

Souligner

• potentiellement plus facile à gérer pour les langages de programmation
• plusieurs API populaires (Facebook, Netflix, StackExchange, etc.) utilisent des traits de soulignement dans toutes les parties de l'URI.

Je penche vers les soulignés pour tout. Le fait que la plupart des grands joueurs les utilisent est convaincant (voir https://stackoverflow.com/a/608458/360570 ).

Vous devez utiliser des tirets dans l'URL d'une application Web explorable. Pourquoi? Parce que le tiret sépare les mots (afin qu'un moteur de recherche puisse indexer les mots individuels), et n'est pas un caractère de mot . Le soulignement est un caractère de mot, ce qui signifie qu'il doit être considéré comme faisant partie d'un mot.

Double-cliquez sur ceci dans Chrome: camelCase
Double-cliquez sur cela dans Chrome: under_score
Double-cliquez sur cela dans Chrome: trait d'union

Voyez comment Chrome (j'entends Google fait un moteur de recherche aussi) pense seulement que l'un d'entre eux est deux mots?

camelCaseet underscoreobligent également l'utilisateur à utiliser la shiftclé, alors hyphenatedqu'il ne le fait pas.

Donc, si vous devez utiliser des tirets dans une application Web explorable, pourquoi vous embêteriez-vous à faire quelque chose de différent dans une application intranet? Une chose de moins à retenir.

La meilleure pratique standard pour les API REST est d'avoir un trait d'union , et non un chameau ou des traits de soulignement.

Cela vient du «REST API Design Rulebook» de Mark Masse d'Oreilly.

De plus, notez que Stack Overflow lui-même utilise des tirets dans l'URL: .../hyphen-underscore-or-camelcase-as-word-delimiter-in-uris

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

Bien que je recommande les tirets, je postulerai également une réponse qui ne figure pas sur votre liste:

Rien du tout

• L'API de mon entreprise a des URI comme /quotationrequests/, /purchaseorders/etc.
• Bien que vous ayez dit qu'il s'agissait d'une application intranet, vous avez cité le référencement comme un avantage. Google correspond au modèle / foobar / dans une URL pour une requête de?q=foo+bar
• J'espère vraiment que vous n'envisagez pas d'exécuter un appel PHP à une chaîne arbitraire que l'utilisateur transmet à la barre d'adresse, comme le suggère @ ServAce85!

En général, cela n'aura pas suffisamment d'impact à craindre, d'autant plus qu'il s'agit d'une application intranet et non d'une application Internet à usage général. En particulier, puisqu'il s'agit d'un intranet , le référencement n'est pas un problème, car votre intranet ne devrait pas être accessible aux moteurs de recherche. (et si c'est le cas, ce n'est pas une application intranet).

Et tout cadre qui en vaut la peine a déjà une méthode par défaut pour le faire, ou il est assez facile de changer la façon dont il traite les composants d'URL multi-mots, donc je ne m'inquiéterais pas trop.

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

Trait d'union

• Le plus grand danger pour les tirets est que le même caractère (généralement) est également utilisé pour la soustraction et la négation numérique (c'est-à-dire moins ou négatif ).
• Les tirets se sentent maladroits dans les composants URL. Ils semblent n'avoir de sens qu'à la fin d'une URL pour séparer les mots dans le titre d'un article. Ou, par exemple, le titre d'une question Stack Overflow qui est ajoutée à la fin d'une URL à des fins de référencement et de clarté utilisateur.

Souligner

• Encore une fois, ils se sentent mal dans les composants URL. Ils décomposent le flux (et la beauté / simplicité) d'une URL, car ils ajoutent essentiellement un grand espace apparent lourd au milieu d'une URL claire et fluide.
• Ils ont tendance à se fondre dans les soulignements. Si vous vous attendez à ce que vos utilisateurs copient-collent vos URL dans MS Word ou d'autres programmes d'édition de texte similaires, ou n'importe où ailleurs qui pourrait récupérer une URL et la styliser avec un soulignement (comme les liens le sont traditionnellement ), alors vous voudrez peut-être évitez les traits de soulignement comme séparateurs de mots. En particulier lors de l'impression, une URL soulignée avec des traits de soulignement a tendance à ressembler à des espaces à la place des traits de soulignement.

Affaire de chameau

• De loin mon préféré, car il fait que les URL semblent mieux circuler et n'a aucun des défauts des deux options précédentes.
• Peut être légèrement plus difficile à lire pour les personnes qui ont du mal à différencier les majuscules des minuscules, mais cela ne devrait pas être un gros problème dans une URL, car la plupart des "mots" doivent être des composants d'URL et séparés par un de /toute façon . Si vous trouvez que vous avez un composant URL de plus de 2 "mots", vous devriez probablement essayer de trouver un meilleur nom pour ce concept.
• Il ne un problème possible avec sensibilité à la casse, mais la plupart des plates - formes peuvent être ajustées pour être soit sensible à la casse ou insensible à la casse. Tout ce n'est vraiment un problème que pour 2 cas: a.) Les humains tapant l'URL, et b.) Les programmeurs (puisque nous ne sommes pas humains) tapant l'URL. Les fautes de frappe sont toujours un problème, indépendamment de la sensibilité à la casse, c'est donc pas différent que tous les cas.

Réponse courte:

mots en minuscule avec un trait d'union comme séparateur

Longue réponse:

À quoi sert une URL?

Si pointer vers une adresse est la réponse, alors une URL raccourcie fait également du bon travail. Si nous ne facilitons pas la lecture et la maintenance, cela n'aidera pas autant les développeurs que les mainteneurs. Ils représentent une entité sur le serveur, ils doivent donc être nommés logiquement.

Google recommande d'utiliser des tirets

Pensez à utiliser la ponctuation dans vos URL. L'URL http://www.example.com/green-dress.html nous est beaucoup plus utile que http://www.example.com/greendress.html . Nous vous recommandons d'utiliser des tirets (-) au lieu des traits de soulignement (_) dans vos URL.

Issu d'une formation en programmation, camelCase est un choix populaire pour nommer des mots communs.

Mais la RFC 3986 définit les URL comme sensibles à la casse pour différentes parties de l'URL. Étant donné que les URL sont sensibles à la casse, le garder discret (minuscule) est toujours sûr et considéré comme un bon standard. Maintenant, cela prend un étui à chameaux par la fenêtre.

Source: https://metamug.com/article/rest-api-naming-best-practices.html#word-delimiters

voici le meilleur des deux mondes.

J'aime aussi "souligne", outre tous vos points positifs à leur sujet, il y a aussi un certain style old-school.

Donc, ce que je fais, c'est utiliser des tirets bas et simplement ajouter une petite règle de réécriture au fichier .htaccess de votre Apache pour réécrire tous les tirets bas dans des tirets.

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