Routing - dobre praktyki

Routing - dobre praktyki
KL
  • Rejestracja:ponad 4 lata
  • Ostatnio:prawie 4 lata
  • Postów:14
0

screenshot-20201214102329.png

Cześć, tak jak na obrazku powyżej - niby wszystko jasne, ale u mnie moje wiadomości mają unikalne id. Dlatego mógłbym zrobić po prostu coś w stylu

Kopiuj
PUT /messages/5

Ale czy to poprawne? Czy dla picu powinienem używać

Kopiuj
PUT /tickets/12/messages/5

Czy może ja to w ogóle jakoś źle robie? Może dla każdego ticketu wiadomości powinny się zaczynać od 1? W takim razie jak by taka struktura w bazie miała wyglądać?

Patryk27
Moderator
  • Rejestracja:ponad 17 lat
  • Ostatnio:ponad rok
  • Lokalizacja:Wrocław
  • Postów:13042
1

Skoro dorzucenie /tickets/:id do URLa jedynie utrudnia routing oraz obsługiwanie wiadomości, to w jakim celu miałbyś to robić?

Pragmatyzm oraz prostota ponad puryzm.

W takim razie jak by taka struktura w bazie miała wyglądać?

Mógłbyś utworzyć dodatkowe pole o nazwie incremental_id z unikalnym kluczem na (ticket_id, incremental_id) (tak robi np. Magento dla idków zamówień) - przy czym imho nie ma to sensu, ponieważ jedynie zaciemi to wczytywanie oraz tworzenie nowych wiadomości (insert into będziesz musiał poprzedzić select max(...) + 1 ...).


edytowany 1x, ostatnio: Patryk27
TR
  • Rejestracja:ponad 7 lat
  • Ostatnio:około miesiąc
  • Lokalizacja:700m n.p.m.
  • Postów:677
1

Takie podejście do rozpoznawania parametrów to przy bardzo prostych serwisach i bardzo prostych zapytaniach.

I tu kolejny problem: proste serwisy mogą się w pewnym momencie rozbudować do dużych (mniejsza w tym momencie o kryteria podziału).

W każdym razie przy większych serwisach gdzie masz więcej operacji niż CRUD, tego typu konstrukcje to jakaś masakra, tak samo jak przekazywanie parametrów w ten sposób:

/moje/przeboje,param,param,param,param (np. /moje/przeboje,12,34,fr,23534)

Dlaczego u niektórych istnieje taka awersja przed tradycyjnymi parametrami przekazywanymi w tradycyjny sposób (?param=val&param=val), które co więcej są rozpoznawane przy POST nie tylko przy GET, i uelastyczniają cały system.


DRY > SOLID (nie bierz tego zbyt poważnie)
VO
  • Rejestracja:ponad 4 lata
  • Ostatnio:około 4 lata
  • Postów:4
1

Z tego co pokazujesz na poczatku, to projektujesz swoje api na kształt REST-owego. Jeśli tak jest, to warto trzymać się powszechnie przyjetych konwencji (chyba że to mały serwis ale - one szybko rosną). To ułatwia pracę np. tym którzy przejmą twoj kod, albo będa z nim pracować, ogladać go, używać.
Tu jest jeden z wielu przewodników po budowie RESTapi - https://restfulapi.net/rest-api-design-tutorial-with-example/#model-uris. Poczytaj, nawet jeśli twoj bedzie tylko REST, a nie RESTfull.
A poza tym tak skonstruowany uri tickets/12/messages/5 od razu zwiera w sobie sporo informacji, które w przeciwnym wypadku musiałbyś wyciągać z bazy. Oczywiście i tak trzeba je walidować, ale na dzień dobry dostajesz jaśniejszą strukturę.
No i polecem nie uzywac intów jako indentyfikatorów, tylko przejśc na UUID-y.

Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)