Django – #34 – REST API cz. 9 – RetrieveUpdateAPIView

Wprowadzenie.

We wpisie przedstawiłem kolejną klasę generyczną RetrieveUpdateAPIView, dzięki której jesteśmy w stanie odczytywać określone rekordy z bazy danych oraz je aktualizować. Ze względu, że mechanizm odczytywania jest taki sam jak przy już omawianej klasie generycznej RetrieveDestroyAPIView, dlatego w tym wpisie przedstawię jedynie funkcjonalność aktualizacji danych.

Spis treści serii

1. Django REST API cz. 1– Tworzenie nowego projektu 
2. Django REST API cz. 2 – ListAPIView 
3. Django REST API cz. 3 – Wbudowana strona logowania
4. Django REST API cz. 4 – Widoki generyczne
5. Django REST API cz. 5 – ListCreateAPIView i konfiguracja dostępu
6. Django REST API cz. 6 – Uszczegóławianie odpowiedzi  
7. Django REST API cz. 7 – Określenie z góry wartości danych
8. Django REST API cz. 8 – RetrieveDestroyAPIView
9. Django REST API cz. 9 – RetrieveUpdateAPIView ⇐
10. Django REST API cz. 10 – Nadpisywanie zachowań metod przed/po operacji zapisu/usuwania
11. Django REST API cz. 11 – Rejestracja nowego użytkownika poprzez API  
12. Django REST API cz. 12 – Uwierzytelnianie przy pomocy Tokena 
13. Django REST API cz. 13 – Generowanie tokena dla istniejących użytkowników

Zakres artykułu.

• Aktualizacja rekordów w bazie danych – RetrieveUpdateAPIView

Aktualizacja rekordów w bazie danych – RetrieveUpdateAPIView

Wyobraźmy sobie następującą sytuację. Po wypełnieniu i wysłaniu formularza z wypożyczeniem książki, popełniliśmy błąd i wybraliśmy nie tą książkę co chcieliśmy. W takim przypadku możemy albo usunąć dany rekord co już dobrze znamy lub też zmienić dane w tym rekordzie. W celu zmienienia danych może na przykład zastosować klasę generyczną RetrieveUpdateAPIView. Napiszmy zatem nową klasę widoku, która będzie miała następującą postać.   

Standardowo kolejnym krokiem jest stworzenie ścieżki url do wywołania naszej klasy. Ta część kodu wygląda następująco path(’api/borrows//edit/’, views.BorrowRetrieveUpdate.as_view()).

Ostatnim krokiem jest przetestowanie, czy wszystko poprawnie działa. Przejdźmy zatem pod adres 127.0.0.1:8000/api/borrows/, w celu wybrania interesującego nas rekordu. W moim przypadku będzie to rekord o id 9.

Następnie przejdźmy pod adres 127.0.0.1:8000/api/borrows/9/edit/.

Jak widzimy po wprowadzeniu powyższego adresu, odczytaliśmy dane rekordu o id 9, a na dole mamy formularz, który jak się przyjrzymy, możemy wysłać metodą PUT. Dla przypomnienia metoda PUT odpowiedzialna jest za aktualizację całego rekordu.

Po wprowadzeniu danych i wysłaniu formularza metodą PUT dane zostaną zaktualizowane.

Sprawdźmy jeszcze dla pewności czy dane zostały zaktualizowane, gdy wpiszemy adres 127.0.0.1:8000/api/borrows.

Jak widzimy, wszystko ładnie działa, choć tak naprawdę nie do końca, ponieważ aktualnie jesteśmy w stanie modyfikować także dane wypożyczeń innych użytkowników. W takim przypadku musimy wykonać podobne czynności jak przy usuwaniu rekordów.

Nadpiszmy zatem metodę PUT w taki sposób, aby filtrowała nam zwracany obiekt nie tylko po pk, lecz również po użytkowniku, który wysyła zapytanie. W przypadku, jeżeli obiekt będzie istniał, wówczas zostanie wywołana metoda update, zgodnie ze standardowym procesem, a w przypadku, gdy obiekt nie będzie istniał, wówczas zostanie zwrócony błąd, który poinformuje, że nie jesteśmy właścicielem tego wypożyczenia.

Możemy teraz ponownie przetestować, czy gdy będziemy chcieli zmodyfikować wypożyczenie inne niż nasze, system rzeczywiście zwróci nam błąd.

Przejdźmy pod adres 127.0.0.1:8000/api/borrows/, aby zobaczyć pełną listę wypożyczeń.

Jak możemy zauważyć, nie jesteśmy właścicielem wypożyczenia o id 4. Przejdźmy zatem pod adres 127.0.0.1:8000/api/borrows/4/edit/. 

W tym miejscu warto zaznaczyć, że jesteśmy w stanie odczytać nie nasz rekord, ponieważ dokonaliśmy modyfikacji jedynie metody PUT, która jest odpowiedzialna za modyfikację, a nie odczyt danych.

Wprowadźmy zmodyfikowane dane do formularza i wyślijmy go metodą PUT. 

Jak widzimy, API zwróciło nam informację, że nie jesteśmy właścicielami tego wypożyczenia. Przejdźmy teraz do wyświetlenia listy wypożyczeń.

Zgodnie z oczekiwaniami rekord o id 4 nie został zmodyfikowany.

Spis treści serii

1. Django REST API cz. 1– Tworzenie nowego projektu 
2. Django REST API cz. 2 – ListAPIView 
3. Django REST API cz. 3 – Wbudowana strona logowania
4. Django REST API cz. 4 – Widoki generyczne
5. Django REST API cz. 5 – ListCreateAPIView i konfiguracja dostępu
6. Django REST API cz. 6 – Uszczegóławianie odpowiedzi  
7. Django REST API cz. 7 – Określenie z góry wartości danych
8. Django REST API cz. 8 – RetrieveDestroyAPIView
9. Django REST API cz. 9 – RetrieveUpdateAPIView ⇐
10. Django REST API cz. 10 – Nadpisywanie zachowań metod przed/po operacji zapisu/usuwania
11. Django REST API cz. 11 – Rejestracja nowego użytkownika poprzez API  
12. Django REST API cz. 12 – Uwierzytelnianie przy pomocy Tokena 
13. Django REST API cz. 13 – Generowanie tokena dla istniejących użytkowników

Autor artykułu
Dominik Bednarski