Trattino, trattino basso o camelCase come delimitatore di parole negli URI?

Sto progettando un'API basata su HTTP per un'app Intranet. Mi rendo conto che è una preoccupazione piuttosto piccola nel grande schema delle cose, ma: dovrei usare trattini, trattini bassi o camelCase per delimitare le parole negli URI?

Ecco i miei pensieri iniziali:

camelCase

• possibili problemi se il server non fa distinzione tra maiuscole e minuscole
• sembra avere un uso abbastanza diffuso nelle chiavi della stringa di query ( http://api.example.com ? searchQuery = ...), ma non in altre parti dell'URI

Trattino

• più esteticamente piacevole rispetto alle altre alternative
• sembra essere ampiamente usato nella parte del percorso dell'URI
• mai visto chiave di stringa di query sillabata in natura
• forse meglio per il SEO (questo potrebbe essere un mito)

Sottolineare

• potenzialmente più facile da gestire per i linguaggi di programmazione
• diverse API popolari (Facebook, Netflix, StackExchange, ecc.) utilizzano i caratteri di sottolineatura in tutte le parti dell'URI.

Sono incline a sottolineare per tutto. Il fatto che la maggior parte dei grandi giocatori li stia utilizzando è avvincente (vedi https://stackoverflow.com/a/608458/360570 ).

È necessario utilizzare trattini in un URL di applicazione Web di cui è possibile eseguire la scansione. Perché? Perché il trattino separa le parole (in modo che un motore di ricerca possa indicizzare le singole parole) e non è un carattere di parola . Il carattere di sottolineatura è un carattere di parola, nel senso che dovrebbe essere considerato parte di una parola.

Fai
doppio clic su Chrome: camelCase Fai doppio clic su Chrome: under_score Fai
doppio clic su Chrome: trattino

Vedi come Chrome (ho sentito che anche Google crea un motore di ricerca) pensa che una di queste sia solo due parole?

camelCasee underscorerichiede anche all'utente di utilizzare la shiftchiave, mentre hyphenatednon lo fa.

Quindi, se dovessi usare trattini in un'applicazione web a scorrimento, perché dovresti preoccuparti di fare qualcosa di diverso in un'applicazione intranet? Una cosa in meno da ricordare.

La best practice standard per le API REST è avere un trattino , non un camelcase o un trattino basso.

Questo deriva dal "Rulebook Design Rulebook" di Mark Masse di Oreilly.

Inoltre, tieni presente che Stack Overflow stesso utilizza trattini nell'URL: .../hyphen-underscore-or-camelcase-as-word-delimiter-in-uris

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

Mentre raccomando trattini, postulo anche una risposta che non è nella tua lista:

Niente di niente

• API della mia azienda ha URI come /quotationrequests/, /purchaseorders/e così via.
• Nonostante tu abbia detto che era un'app Intranet, hai elencato la SEO come un vantaggio. Google corrisponde al modello / foobar / in un URL per una query di?q=foo+bar
• Io veramente spero che non si considera l'esecuzione di una chiamata PHP per qualsiasi stringa arbitraria l'utente passa alla barra degli indirizzi, come @ ServAce85 suggerisce!

In generale, non avrà abbastanza impatto di cui preoccuparsi, soprattutto perché è un'app Intranet e non un'app Internet di uso generale. In particolare, dal momento che è intranet , SEO non è un problema, dal momento che la tua intranet non dovrebbe essere accessibile ai motori di ricerca. (e se lo è, non è un'app Intranet).

E qualsiasi framework degno di nota ha già un modo predefinito per farlo, oppure è abbastanza facile cambiare il modo in cui gestisce i componenti URL a più parole, quindi non me ne preoccuperei troppo.

Detto questo, ecco come vedo le varie opzioni:

Trattino

• Il più grande pericolo per i trattini è che lo stesso carattere (tipicamente) sia usato anche per sottrazione e negazione numerica (es. Meno o negativo ).
• I trattini si sentono scomodi nei componenti URL. Sembrano avere senso solo alla fine di un URL per separare le parole nel titolo di un articolo. O, ad esempio, il titolo di una domanda Stack Overflow che viene aggiunta alla fine di un URL per scopi SEO e di chiarezza dell'utente.

Sottolineare

• Ancora una volta, si sentono in errore nei componenti URL. Interrompono il flusso (e la bellezza / semplicità) di un URL, poiché essenzialmente aggiungono uno spazio apparente grande e pesante nel mezzo di un URL pulito e scorrevole.
• Tendono a fondersi con sottolineature. Se ti aspetti che i tuoi utenti copino e incollino i tuoi URL in MS Word o altri programmi di modifica del testo simili, o in qualsiasi altro luogo che potrebbe captare un URL e modellarlo con una sottolineatura (come tradizionalmente sono i link ), allora potresti voler evitare i trattini bassi come separatori di parole. Soprattutto quando viene stampato, un URL sottolineato con caratteri di sottolineatura tende a sembrare che abbia spazi al posto dei caratteri di sottolineatura.

CamelCase

• Di gran lunga il mio preferito, dal momento che fa sembrare che gli URL scorrano meglio e non presenta alcun difetto delle due opzioni precedenti.
• Può essere un po ' più difficile da leggere per le persone che hanno difficoltà a distinguere maiuscole da minuscole, ma questo non dovrebbe essere molto più di un problema in un URL, perché la maggior parte "parole" dovrebbero essere i componenti di URL e separati da un /comunque . Se scopri di avere un componente URL che è più lungo di 2 "parole", probabilmente dovresti cercare di trovare un nome migliore per quel concetto.
• Esso ha un problema possibile con sensibilità caso, ma maggior parte delle piattaforme può essere regolata per essere una o case-insensitive-sensitive. Qualunque sia davvero un problema per 2 casi: a.) Umani che digitano l'URL, e b.) Programmatori (poiché non siamo umani) che digitano l'URL. I Typos sono sempre un problema, indipendentemente dalla distinzione tra maiuscole e minuscole, quindi questo è non diverso da tutto un caso.

Risposta breve:

parole minuscole con un trattino come separatore

Risposta lunga:

Qual è lo scopo di un URL?

Se la risposta è puntare a un indirizzo, anche un URL abbreviato sta facendo un buon lavoro. Se non semplifichiamo la lettura e la manutenzione, non aiuterebbe sviluppatori e manutentori. Rappresentano un'entità sul server, quindi devono essere denominati logicamente.

Google consiglia di utilizzare trattini

Prendi in considerazione l'utilizzo della punteggiatura nei tuoi URL. L'URL http://www.example.com/green-dress.html ci è molto più utile di http://www.example.com/greendress.html . Ti consigliamo di utilizzare trattini (-) invece di trattini bassi (_) nei tuoi URL.

Proveniente da un background di programmazione, camelCase è una scelta popolare per la denominazione di parole comuni.

Ma RFC 3986 definisce gli URL con distinzione tra maiuscole e minuscole per le diverse parti dell'URL. Dal momento che gli URL fanno distinzione tra maiuscole e minuscole, tenerlo basso (maiuscolo) è sempre sicuro e considerato un buon standard. Ora questo prende un caso di cammello fuori dalla finestra.

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

ecco il meglio di entrambi i mondi.

Mi piace anche "sottolineare", oltre a tutti i tuoi punti positivi su di loro, c'è anche un certo stile vecchio stile per loro.

Quindi quello che faccio è usare i trattini bassi e semplicemente aggiungere una piccola regola di riscrittura al file .htaccess di Apache per riscrivere tutti i trattini bassi nei trattini.

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