Web API

Wtyczka daje dostęp do danych przechowywanych w bazie danych. Zbudowana z ASP.NET Web API oraz OData. Wymaga wiedzy n temat struktury bazy danych nopCommerce
Obrazek WEB API for nopCommerce 3.90 (oData 4.0)
WEB API for nopCommerce 3.90 (oData 4.0)
596,00 zł
796,00 zł
Obrazek WEB API for nopCommerce 4.00 (oData 4.0)
WEB API for nopCommerce 4.00 (oData 4.0)
596,00 zł
796,00 zł
Obrazek WEB API for nopCommerce 4.10 (oData 4.0)
WEB API for nopCommerce 4.10 (oData 4.0)
596,00 zł
796,00 zł

ASP.NET Web API to framework. Wykorzystuje HTTP jako protokół aplikacji do zwrócenia zapytań z bazy danych. Domyślnie dostarcza odpowiedzi w w formacie dokumentu JSON.

CRUD to "Create - tworzyć/Read - czytać/Update - aktualizować/Delete - kasować" i oznacza cztery podstawowe operacje wykonywane na bazie danych. 

Metody:

Cztery główne metody HTTP (GET, PUT, POST, PATCH oraz DELETE) mogą być przypisane do operacji CRUD w następujący sposób:

  • GET pobiera reprezentację zasobu z określonym URI. GET nie powinno mieć żadnych skutków ubocznych dla serwera.
  • PUT akutalizuje zasób z określonym URI. PUT może być również wykorzystane do tworzenia nowego zasobu z określonym URI, jeśli serwer umożliwia klientom tworzyć nowe URI. W tym tutorialu tworzenie nowych zasobów przy użyciu PUT nie jest wspierane. 
  • PATCH aktualizuje dane w bazie (nie wszystkie pola są wymagane).
  • POST tworzy nowy zasób. Serwer pzypisuje URI dla nowego obiektu i zwraca ten URI jako części komunikatu odpowiedzi.
  • DELETE usuwa zasób o określonym URI.

Włączanie opcji OData Query:

Web API wspiera poniższe opcje OData query:

OpcjaOpis
$expand Rozszerza zapytanie o elementy konieczne w odpowiedzi.
$filter Filtr wyników.
$orderby Sortowanie wyników.
$select Wybiera którą własność dołączyć do odpowiedzi.
$skip Pomija n pierwszych wyników.
$top Zwraca tylko pierwszy wynik.

Korzystanie z $select, $expand oraz $value przy użyciu Web API

Web API 2 dodało wsparcie dla opcji OData $expand, $select, $value. Te opcje umożliwiają klinetowi kontrolą reprezentacji pobieranej z serwera.

$expand poszerza zapytanie o elementy, które należy uwzględnić w odpowiedzi.
$select wybiera podzbiór własności koniecznych do odpowiedzi.
$value pobiera wartość konkretnej własności.

back to top