Myślnik, podkreślnik lub camelCase jako ogranicznik słów w Uri?

Standardową najlepszą praktyką dla API REST jest posiadanie myślnika , a nie camelcase lub podkreślenia.

To pochodzi z "REST API Design Rulebook" Marka Masse ' a z Oreilly.

Ponadto należy pamiętać, że sam Stack Overflow używa myślników w adresie URL: .../hyphen-underscore-or-camelcase-as-word-delimiter-in-uris

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

Podczas gdy polecam myślniki, postuluję również odpowiedź, której nie ma na twojej liście:

Nic W Ogóle

• API mojej firmy MA URI jak /quotationrequests/, /purchaseorders/ i tak dalej.
• pomimo, że mówiłeś, że to aplikacja intranetowa, wymieniłeś SEO jako korzyść. Google dopasowuje wzorzec / foobar / w adresie URL dla zapytania ?q=foo+bar
• i naprawdę mam nadzieję, że nie rozważasz wykonania wywołania PHP na dowolny dowolny ciąg znaków, który użytkownik przekazuje do pasek adresu, jak sugeruje @ServAce85!

Ogólnie rzecz biorąc, nie będzie to miało wystarczającego wpływu, szczególnie, że jest to aplikacja intranetowa , a nie aplikacja internetowa ogólnego użytku. W szczególności, ponieważ jest to intranet , SEO nie jest problemem, ponieważ twój intranet nie powinien być dostępny dla wyszukiwarek. (a jeśli tak, to nie jest to aplikacja intranetowa).

I każdy framework, który jest wart soli, albo ma już domyślny sposób, aby to zrobić, albo jest dość łatwy do zmiany, jak radzi sobie z komponentami URL z wieloma wyrazami, więc nie martwiłbym się o to zbytnio.

To powiedziawszy, oto jak widzę różne opcje:

Myślnik

• największym zagrożeniem dla myślników jest to, że ten sam znak (zazwyczaj) jest również używany do odejmowania i negacji numerycznej (tj. minus lub minus ).
• myślniki czuć niewygodne w komponentach URL. Wydają się mieć sens tylko na końcu adresu URL, aby oddzielić słowa w tytule artykułu. Lub, na przykład, tytuł pytania o przepełnienie stosu, które jest dodawane na końcu adresu URL do celów SEO i przejrzystości użytkownika.

Podkreślenie

• ponownie czują się źle w komponentach URL. Rozbijają przepływ (i piękno/prostotę) adresu URL, ponieważ zasadniczo dodają dużą, ciężką pozorną przestrzeń w środku czystego, płynącego adresu URL.
• mają tendencję do wtapiania się w podkreślenia. Jeśli oczekujesz, że użytkownicy skopiują-wkleją Twoje adresy URL do MS Word lub innych podobnych programy do edycji tekstu, lub gdziekolwiek indziej, które mogą podnieść na URL i styl go z podkreślenia (jak linki tradycyjnie są), to może warto unikać podkreślenia jako separatory słów. Szczególnie po wydrukowaniu podkreślony adres URL z podkreślnikami wygląda tak, jakby miał w sobie spacje zamiast podkreślników.

CamelCase

• zdecydowanie mój ulubiony, ponieważ sprawia, że adresy URL wydają się lepiej przepływać i nie ma żadnych wad że poprzednie dwie opcje zrobić.
• może być lekko trudniejsze do odczytania dla osób, które mają trudności z odróżnianiem wielkich liter od małych, ale nie powinno to stanowić większego problemu w adresie URL, ponieważ większość "słów" powinna być składnikami URL i oddzielona / tak czy inaczej. Jeśli okaże się, że masz komponent URL, który ma więcej niż 2 "słowa", prawdopodobnie powinieneś spróbować znaleźć lepszą nazwę dla tego pojęcia.
• It does have a possible problem with case czułość, ale większość platform może być dostosowana tak, aby rozróżniała wielkość liter lub wielkość liter. W każdym razie jest to tylko naprawdę problem dla 2 przypadków: a.) ludzie wpisując adres URL i B.) Programiści (ponieważ nie jesteśmy ludźmi) wpisując adres URL. Literówki są Zawsze problemem, bez względu na wielkość liter, więc nie różni się to niczym od jednego przypadku.

Oto najlepsze z obu światów.

Ja też "lubię" podkreślenia, oprócz wszystkich twoich pozytywnych punktów na ich temat, jest też pewien staromodny styl.

Więc to, co robię, to używam podkreślników i po prostu dodaję małą regułę przepisywania do Twojego Apache ' a .plik htaccess do ponownego zapisu wszystkich podkreślników do myślników.

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