REST API - jakie endpointy?

REST API - jakie endpointy?
IN
  • Rejestracja:prawie 10 lat
  • Ostatnio:ponad 4 lata
  • Postów:4
0

Cześć,

ostatnio próbuję napisać proste REST API. Poczytałem co nieco o dobrych praktykach i znalazłem, że dobrze jest dostarczać "zagnieżdżone" endpointy (swoją drogą nie wiem jakiej nomenklatury używać do tego, co chcę opisać). Ale do rzeczy.

Przykładowo : mam relację ManyToMany pomiędzy encją Team i Member - każdy Team ma wiele Memberów, a każdy Member należy do wielu Teamów. I oczywiste wydają się takie endpointy (na razie skupiam się na GET):

GET /teams
GET /members
GET /teams/{id}
GET /members/{id}

Idąc dalej tym tokiem wydaje się sensowne, aby zapewnić również:

GET /teams/{id}/members
GET /members/{id}/teams

I jeszcze dalej...

GET /teams/{id}/members/{id}
GET /members/{id}/teams/{id}
GET /teams/{id}/members/{id}/teams
GET /members/{id}/teams/{id}/members

I tak w koło Macieju...

Stąd moje pytanie - czy taki właśnie jest zamysł REST API czy czegoś nie do końca rozumiem? Jeśli tak, to czy istnieje jakiś sprytny trik (jakieś redirecty?) na zrealizowanie czegoś takiego? Piszę to w Spring Boocie ze Spring Data.

I na koniec taka moja obserwacja - szokujące, ile jest tutoriali uczących złych praktyk i łamiących wszystkie zasady RESTa :D

S9
  • Rejestracja:ponad 10 lat
  • Ostatnio:5 miesięcy
  • Lokalizacja:Warszawa
  • Postów:3573
2

Według mnie GETna takie endpointy jak:
/teams/{team_id}/memember/{memember_id} raczej sensu nie mają.
Informacje o zespole uzyskujesz uderzajac pod endpoint /teams/{team_id} zaś o członku memember/{memember_id}
/teams/{team_id}/memembers/{memember_id} mogłoby być dobre bardziej pod DELETE, ew. PUT w celu edycji powiązania (usuniecie członka z zespołu np.)


"w haśle <młody dynamiczny zespół> nie chodzi o to ile masz lat tylko jak często zmienia się skład"
axde
  • Rejestracja:ponad 5 lat
  • Ostatnio:prawie 5 lat
2
invisus napisał(a):

(...)
I na koniec taka moja obserwacja - szokujące, ile jest tutoriali uczących złych praktyk i łamiących wszystkie zasady RESTa :D

Takie rzeczy w Java to standard. Jest 1000 artykułów na ten sam temat, a 998 z nich jest przepisanych jeden do jednego z innego z tymi samymi błędami.
Łap fajny treściwy i krótki tutorial:

Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
4

Wystawiaj endpointy które mają jakiś biznesowy sens. Jak chcesz zdumpować restem całą bazę danych to weź sobie Spring Data Rest i w ogóle nie pisz zadnego kodu. Sens niewielki, no ale jak ktoś lubi to kto mu zabroni?


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
IN
  • Rejestracja:prawie 10 lat
  • Ostatnio:ponad 4 lata
  • Postów:4
0

Dzięki Panowie, o to chodziło :) To, że takie chainowanie endpointów nie jest szczególnie wartościowe to się domyślałem i nie jest moim celem. Bardziej zastanawiałem się, czy nie robi się czegoś takiego jakimś automagicznym sposobem.

Charles_Ray
  • Rejestracja:prawie 17 lat
  • Ostatnio:około 3 godziny
  • Postów:1873
1

Tak jak @Shalom napisał, nie do tego to służy. Rest jest stylem architektonicznym, a nie ładnymi urlami.


”Engineering is easy. People are hard.” Bill Coughran
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)