Czy warto korzystać z API Platform?

Cały framework opiera się na PHP 8.2+ i Symfony 7, czyli naprawdę solidnych fundamentach, biorąc pod uwagę stopień rozbudowania tego ekosystemu. Z kolei do zarządzania bazą danych korzysta z Doctrine ORM – kolejnej popularnej i mocno wspieranej biblioteki PHP, która ułatwia zarządzanie relacjami między encjami, upraszcza migracje schematów, a nawet dodaje lazy loading do obsługi zapytań do bazy.

Sama architektura frameworka zmieniała się przez lata. Prawdpodobnie najważniejszą zmianą, która znacznie ułatwiła pracę developerom, było przejście na natywne atrybuty PHP wraz z pojawieniem się wersji 8.0 tego języka. W starszych wersjach platformy trzeba było definiować konfigurację API albo w osobnych plikach YAML, albo w komentarzach DocBlock. Problem w tym, że wszystkie IDE traktowały te konfiguracje jak zwykły tekst. Atrybuty PHP widzą je już jako kod, więc mogą np. wykrywać w nich błędy składniowe.

Tak mogłaby wyglądać bardzo prosta implementacja API w najnowszej wersji API Platform:

namespace App\Entity;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection; 
use ApiPlatform\Metadata\Post;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
#[ApiResource(
   operations: [
       new GetCollection(),
       new Post(),          
       new Get(),           
    ]
)]
class Book
{
   #[ORM\Id, ORM\Column, ORM\GeneratedValue]
   private ?int $id = null;

   #[ORM\Column]
   public ?string $title = null;

I to w zasadzie wszystko – jeden plik wystarczy, aby API Platform automatycznie wygenerowało gotowy do użycia interfejs.

Jedną z bardziej praktycznych zalet API Platform jest fakt, że nie musisz wybierać, czy stworzysz API w REST, czy w GraphQL – framework przygotuje oba interfejsy na podstawie tych samych encji PHP. Co prawda domyślnie robi to w REST, ale aby włączyć też GraphQL, wystarczy zainstalować jeden pakiet:

composer require api-platform/graphql

Cała logika API – filtry, zasady walidacji i autoryzacji zapytań – zadziała dokładnie tak samo w obu wersjach interfejsu.

To nie wszystko, bo framework zapewnia też narzędzie – Create Client – do generowania prostych skryptów frontendowych pod Reacta, Next.js oraz Vue.

Po zdefiniowaniu zasobów API generator analizuje jego strukturę i tworzy komponenty UI w TypeScript’cie, które da się później dowolnie zmodyfikować. Może to być np. formularz do edycji danych albo lista z paginacją. Dla projektów w React’cie i Next.js generator domyślnie korzysta z biblioteki React Admin, w przypadku Vue – z Nuxt.js.

Create Client ma dosyć ograniczone możliwości. Przygotuje tylko wybrane, niezbyt skomplikowane komponenty (o czym możesz przeczytać w oficjalnej dokumentacji API Platform), ale np. przy budowie prostego panelu administracyjnego jak najbardziej również może się przydać.

API Platform ma także wbudowaną integrację z protokołem Mercure, który pozwala wymieniać informacje między bazą danych a przeglądarką w czasie rzeczywistym. Jeśli dane się zmienią, na ekranie użytkownika będzie to widoczne po kilku sekundach. To dobra alternatywa dla protokołu WebSocket, który działa podobnie, ale wymaga więcej pracy przy konfiguracji. Dodatkowo, Mercure działa wg standardu Server-Sent Events, który dziś obsługuje każda przeglądarka bez konieczności instalowania dodatkowych bibliotek.

Tak jak wspominaliśmy na początku, framework natywnie wspiera format JSON-LD oraz standard Hydra. To szczególnie ważne w kontekście tego, jak Twoją stronę lub aplikację będą widziały algorytmy wyszukiwarek.

JSON-LD to format danych strukturalnych rekomendowany od dawna przez Google. Dzięki temu, że interfejs przygotowany w API Platform automatycznie zwraca dane właśnie w tym formacie, roboty wyszukiwarek są w stanie łatwo rozpoznać dany zasób: czy to produkt, artykuł, recenzja, czy np. wydarzenie. Na przykład odpowiedź API dla produktu mogłaby wyglądać tak:

{
  "@context": "https://schema.org",
  "@type": "Product",
  "@id": "/api/products/123",
  "name": "Laptop Dell XPS 15",
  "description": "Wysokowydajny laptop z procesorem Intel i7",
  "price": {
    "@type": "Offer",
    "price": "5999.00",
    "priceCurrency": "PLN"
  },
  "brand": {
    "@type": "Brand",
    "name": "Dell"
  }
}

Wszystkie informacje są oznaczone zgodnie z wytycznymi schema.org, więc algorytm wie od razu, jak interpretować strukturę danych. To z kolei zwiększa szanse, że strona pojawi się w wynikach wyszukiwania wraz z tzw. rich snippets.