Does this skill help with testing the new endpoints?

Yes, it provides specific instructions for adding and running e2e-api tests in the ghost/core/test/e2e-api/admin directory to ensure functionality.

How do I register a new route for the Ghost Admin API?

You must add the routes for each endpoint to the ghost/core/core/server/web/api/endpoints/admin/routes.js file.

Where are the Ghost Admin API endpoint files located?

New endpoint files are typically created or modified in the ghost/core/core/server/api/endpoints/ directory.

What is the @tryghost/api-framework used for?

It is Ghost's internal framework used to define controller objects, documentation names, and endpoint definitions like 'browse' or 'read'.

Ghost Admin API Endpoint Creator

Name: Ghost Admin API Endpoint Creator
Author: TryGhost

byTryGhost

•

51,668

•

API Development

Facilitates the creation and integration of new administrative API endpoints within the Ghost publishing platform.

This skill streamlines the process of extending the Ghost CMS Admin API by providing a structured workflow for adding new resources and endpoints. It guides developers through creating controller objects using the @tryghost/api-framework, defining routes in the core server, and implementing end-to-end (E2E) tests to ensure reliability. By standardizing the implementation pattern, it helps maintain consistency across Ghost's backend architecture and accelerates the development of custom administrative features and integrations.

Key Features

01Validation of JSDoc types for API controllers

02End-to-end API testing integration for endpoint validation

03Automated routing registration for the admin API namespace

04Step-by-step guidance for new resource initialization

0551,668 GitHub stars

06Standardized controller creation using Ghost's API framework

Use Cases

01Adding custom management features to the Ghost Admin interface

02Extending the Ghost API to support third-party administrative integrations

03Standardizing backend service exposure through Ghost's internal API framework

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tryghost/ghost add-admin-api-endpoint

For use in Claude.ai and ChatGPT

Download Skill