REST API - jeden generyczny endpoint, czy kilka mniejszych dedykowanych

REST API - jeden generyczny endpoint, czy kilka mniejszych dedykowanych
JE
  • Rejestracja:ponad 4 lata
  • Ostatnio:około rok
  • Postów:7
0

Witam,

chciałbym zapytać co w Waszym przekonaniu jest lepszym rozwiązaniem, jeden generyczny endpoint API, czy kilka konkretnych.

Rozważmy sytuację, nasza firma obsługuje placówki szkolne: SchoolAbc, SchoolDef, SchoolXyz.
Potrzebujemy wystawić API do dodawania uczniów do szkoły (API wewnętrzne tylko i wyłącznie dla frontu, który jest tworzony przez naszą firmę). Każda z tych placówek oczywiście ma swoją logikę i oczekuje innych danych dotyczących uczniów:

  • SchoolAbc: FirstName, LastName, Pesel
  • SchoolDef: FirstName, LastName, BirthDate,
  • SchoolXyz: FirstName, LastName, Pesel, Address, PhoneNumber etc...

Każda z placówek ma też inną walidację, czyli np. SchoolAbc pozwala na dodanie ucznia, jeśli ten nie ukończył 20 roku życia itd.
Do tej pory wystawiałem osobne endpointy dla każdej z placówek czyli:

  • /api/school/abc/students
  • /api/school/def/students
  • /api/school/xyz/students

Każdy z endpointów przyjmował w body inne parametry, które następnie trafiały do dedykowanego placówce command handlera, który był odpowiedzialny za realizację useCase'a (walidacja + wykonanie command'a).
Wydaje mi się to naturalne, natomiast lider mojego zespołu chciałby żeby to wszystko było realizowane przez jeden generyczny endpoint np.

  • /api/students

Czyli przesyłam dane, a następnie dopiero w handlerze, za pomocą fabryki mam zmapować generyczny request na request dedykowany dla konkretnej placówki i wywołać klasę obsługującą logikę odpowiedniej szkoły. Nie widzę zalet takiego rozwiązania, ok jest jeden endpoint, ale to wcale nie znaczy, że jest mniej pracy. W tym przypadku również muszę zaprogramować logikę dla konkretnej szkoły, a dodatkowo dochodzi mi konieczność przemapowania requestów. Odnoszę też wrażenie, że kod staje się też mniej czytelny, jak i samo API.

Co Wy o tym sądzicie?

edytowany 1x, ostatnio: Jeffdot
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
1

Pytanie brzmi ile i jak skomplikowane requesty chcecie obsługiwać. To co piszesz z podziałem na endpointy ma sens jak macie te 2-3 opcje. Co jak będzie ich 10 albo 100? ;)
Rozwiązanie z jednym endpointem to coś na wzór np. API elasticsearcha (wyobraź sobie obsługe query do elastica za pomocą róznych endpointów ;) ).
Może warto pomysleć o czymś w stylu graphql w waszym przypadku? To też taka opcja gdzie jest jeden endpoint, ale jednak format zapytań jest "ustandaryzowany"

edit: dla jasności, ja nie staje po żadnej ze stron bo nie znam twojej domeny, ale widać ze jesteś nastawiony na nie do tej opcji z jednym endpointem więc chciałem tylko zasygnalizować że to czasem ma sens :)


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
edytowany 1x, ostatnio: Shalom
Shalom
Nie wiem czy korzystałeś kiedyś z elastica, popatrz na https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html i zastanów sie jak miałbyś te query ogarnąć wieloma endpointami ;) Popatrz też na https://graphql.org/learn/queries/ kiedy np. wiele pól pomiędzy waszymi szkołami się powtarza i może szaleństwem byłoby robić 100 DTOsów które są do siebie bardzo podobne.
JE
Nie korzystałem, dzięki za podesłanie przykładu ;)
JE
  • Rejestracja:ponad 4 lata
  • Ostatnio:około rok
  • Postów:7
0

Na chwilę obecną są to 4 opcje, natomiast za 2 lata może ich być np. 10. Jeśli chodzi o skomplikowanie, to najprostszy request ma 4 parametry, a najbardziej złożony 18. Możemy założyć, że w takim przedziale będzie się utrzymywać liczba parametrów dla pozostałych placówek szkolnych.

HA
  • Rejestracja:około 6 lat
  • Ostatnio:około godziny
  • Postów:1005
0

Front, różne potrzeby co do zwracanych wyników. Pierwsze co pomyślałem to graphql.

AreQrm
  • Rejestracja:prawie 11 lat
  • Ostatnio:14 dni
  • Lokalizacja:Londyn
  • Postów:873
0

Jak konsultant odpowiem "to zależy".

Jak dobry konsultant spróbuję wyjaśnić od czego. ;-)

Moim zdaniem powinniście pogadać w zespole i wybrać opcję wam najbardziej pasującą.
Opcja z 1 endpointem jest najbardziej RESTowa... ale REST nie jest jedyną słuszną drogą. Zwłaszcza jak wy nie tworzycie dla kogoś API tylko dla własnego frontendu. Kwestia też tego jak to łątwiej ogarnąć na frontendzie bo gdzieś będzie jakaś logika że jak szkoła X to wysyłam ABC, a jak Y to wysyłam FGH. Ale pewnie i tak i siak front musi o tym wiedzieć co wysłać? A może nie... Nie wiem. Ty wiesz (albo ludzie u Ciebie).
Opcja z dedykowanym endpointem zapewnia łatwiejsze obsługiwanie/przepychanie requestu, bo każdy ma swój dedykowany i od razu wiadomo powinno być co który endpoint wymaga. Zależnie od technologii może to też uprościć podstawową walidację, np jeśli wiek się nie zgadza można to od razu ogarnąc adnotacją i framework się zajmie resztą, Ale znów nie wiem co, jak i w czym walidujecie, to może ale nie musi ułatwić życie.
Fakt faktem, że jak jak będzie ich 10 to... będzie ich 10. Albo będzie logika skomplikowana jak z 1 generycznego requestu zrobić niegeneryczny i gdzie go upchać ( przesadzam ze skomplikowaniem, wystarczy Enum z wartością per szkoła i to po jego wartości decydujemy gdzie ten request idzie dalej, ale trochę kodu mapującego jest do zrobienia ekstra).

Kolejny argument który może się pojawić: "A jak trzeba będzie dodać szkołę to ktoś musi dodać nowy endpoint, kod napisać... "No tak, ale trzeba będzie ten kod napisać zawsze, zakodować przerzucenie z generyka do właściwego handlera. Także zero zysku tutaj.
Za to może ale nie musi być zysk na frontendzie, zależnie co on wie i jak jest napisany, że tam nie trzeba nic dodawać i od ręki obsłuży nową szkołę, a w wypadku osobnego endpointu, trzeba front zaktualizować. Ale znów, jeśli i tak trzeba to zrobić...


XardasLord
  • Rejestracja:ponad 11 lat
  • Ostatnio:9 miesięcy
  • Lokalizacja:Gdańsk
  • Postów:271
0

Dla Twojej sytuacji myślę, że warto zainteresować się GraphQL


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

+1 do generycznego endpointu a la ElasticSeach


”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)