add-admin-api-endpoint
Add a new endpoint or endpoints to Ghost's Admin API at `ghost/api/admin/**`.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Add a new endpoint or endpoints to Ghost's Admin API at ghost/api/admin/**.
How to use
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.W pliku endpointa zdefiniuj obiekt kontrolera przy użyciu typu JSDoc z
@tryghost/api-framework(Controller). Kontroler musi zawierać co najmniejdocNameoraz jedną definicję endpointa, na przykładbrowse.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ą konwencjighost/api/admin/**.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.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.Po zatwierdzeniu testów endpoint jest gotowy do użytku w Admin API Ghost'a.