Deprecowanie pól
Wersjonowanie schematu GraphQL polega na deprecowaniu pól, czyli informowaniu użytkownika, że dane pole nie powinno być już używane, i jakim innym polem je zastąpić.
Oprócz deprecowania pól za pomocą kodu, Gato GraphQL udostępnia interfejs użytkownika do konfigurowania, które pola mają być deprecowane i w jaki sposób.
Konfiguracja jest tworzona za pomocą listy deprecacji pól i dostarczana do niestandardowych endpointów oraz persisted queries poprzez konfigurację schematu.
Przeglądanie wszystkich list deprecacji pól
Po kliknięciu "Field Deprecation Lists" w menu wtyczki wyświetlona zostaje lista wszystkich utworzonych list deprecacji pól:
Tworzenie nowej listy deprecacji pól
Kliknij przycisk "Add New Field Deprecation List", aby otworzyć edytor WordPress:
Nadaj liście deprecacji pól tytuł, dodaj wpisy z polami i skonfiguruj komunikat deprecacji. Gdy będziesz gotowy, kliknij przycisk Publish. Nowa lista deprecacji pól stanie się wówczas dostępna dla konfiguracji schematu.
Pole zostanie oznaczone jako zdeprecowane w schemacie, a ponadto komunikat deprecacji będzie wyświetlany w odpowiedzi przy odpytywaniu zdeprecowanego pola (jeśli moduł Deprecation Notifier jest włączony).
Wpisy deprecacji pól
Każda Field Deprecation List zawiera jeden lub więcej wpisów, z których każdy składa się z następujących elementów:
- Pola do zdeprecowania
- Komunikat deprecacji
Wybieranie pól z interfejsów
Oprócz pól z typów można również wybierać pola z interfejsów. W takim przypadku deprecacja jest stosowana do tych pól we wszystkich typach implementujących dany interfejs.
Opisywanie listy deprecacji pól
Użyj pola "Excerpt" w panelu ustawień dokumentu, aby nadać opis liście deprecacji pól.
Więcej informacji znajdziesz w przewodniku Dodawanie opisu do API.
Korzystanie z listy deprecacji pól
Po utworzeniu listy deprecacji pól można sprawić, aby Custom Endpoint lub Persisted Query z niej korzystały, edytując odpowiednią konfigurację schematu, i wybierając ACL z listy w bloku "Field Deprecation Lists".
Jeśli konfiguracja nie zostanie dostosowana, zostaną użyte domyślne Field Deprecation Lists zdefiniowane na stronie Ustawień, w zakładce "Field Deprecation":
