add-admin-api-endpoint

Skill do tworzenia i integracji nowych endpointów w Admin API Ghost'a. Automatyzuje proces dodawania nowych zasobów do API na ścieżce ghost/api/admin/**, od stworzenia pliku kontrolera, przez zdefiniowanie tras, aż po testy end-to-end. Idealne dla programistów rozszerzających funkcjonalność Ghost'a o nowe API endpoints.

1. Sprawdź, czy tworzysz endpoint dla zupełnie nowego zasobu. Jeśli tak, utwórz nowy plik w katalogu ghost/core/core/server/api/endpoints/. Jeśli rozszerzasz istniejący zasób, zlokalizuj jego plik w tym samym katalogu.

2. W pliku endpointa zdefiniuj obiekt kontrolera przy użyciu typu JSDoc z @tryghost/api-framework (Controller). Kontroler musi zawierać co najmniej docName oraz jedną definicję endpointa, na przykład browse.

3. Dodaj trasy dla każdego nowego endpointa do pliku ghost/core/core/server/web/api/endpoints/admin/routes.js. Upewnij się, że ścieżki odpowiadają konwencji ghost/api/admin/**.

4. Utwórz testy end-to-end dla nowego endpointa w katalogu ghost/core/test/e2e-api/admin. Testy powinny weryfikować, że endpoint działa prawidłowo.

5. Uruchom testy poleceniem cd ghost/core && yarn test:single test/e2e-api/admin/{nazwa-pliku-testowego}. Sprawdzaj wyniki i iteruj kod, aż wszystkie testy przejdą pomyślnie.

6. Po zatwierdzeniu testów endpoint jest gotowy do użytku w Admin API Ghost'a.