Poprawne Rest API - najlepsze praktyki itd.

1

Hej,

W internecie sporo jest materiałów, które różnią się różnią i czasami wykluczają.

Chciałbym prosić o materiały z rzetelnych źródeł, może być teoria, ale fajnie byłoby też zobaczyć jakiś przykład takiego api napisanego w javie/springu, whatever.

Chodzi mi o m.in rzeczy takie jak;

  • jak projektować uri pathy
  • w jaki sposób zwracać odpowiedzi z serwera
  • jak sterować obsługą błędów?

itd. tych pytań jest wiele.

Only best practices

Z góry dzięki.

1

To zależy co chcesz zrobić, nie ma znaczenia jak to ograsz w kodzie, ważne byś dał intuicyjną dokuentację. Trzymał się kodów statusów z odpowiedziami. Że np jak ktoś siega po zasoby na wszystkie funkcje getCostam to zwracasz. mu status albo 200 ze OK albo 404 że nie znaleziono. Jak Kasujesz zasoby deleteCOstam to tak samo. Jak tworzysz jakies zasoby to np 201 ze Created, jak nie ma odpowiedzi i blad to kod 500 itd itd.

Nie zawsze też warto stosowac PUT, DELETE, PATCH, GET, czasem wystarczy POST bo ma więcej mozliwości chociaz nie jest idempotentny. Podejrzewam ze ile osob tyle odpowiedzi bedzie tu

2

Allegro przygotowało swoje REST API Guideline: https://github.com/allegro/restapi-guideline, tutaj z tego co wiem poruszone są wszystkie kwestie o które pytasz :)

2

3

Ma przyjmować JSONa i zwracać JSONa xd

Zarejestruj się i dołącz do największej społeczności programistów w Polsce.

Otrzymaj wsparcie, dziel się wiedzą i rozwijaj swoje umiejętności z najlepszymi.