tryghost/ghost

Add Admin API Endpoint

Add a new endpoint or endpoints to Ghost's Admin API at `ghost/api/admin/**`.

Installation

$ npx skills add tryghost/ghost --skill add-admin-api-endpoint

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from tryghost/ghost.

npx skills add tryghost/ghost

Browse all from tryghost/ghost

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 54.7K
License LICENSE
Default branch main
Open issues 34
Status Active

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,051 B
  • docs SUMMARY.md 107 B

History

  1. First recorded snapshot · 85 installs

SKILL.md

Create Admin API Endpoint

Instructions

  1. If creating an endpoint for an entirely new resource, create a new endpoint file in ghost/core/core/server/api/endpoints/. Otherwise, locate the existing endpoint file in the same directory.
  2. The endpoint file should create a controller object using the JSDoc type from (@tryghost/api-framework).Controller, including at minimum a docName and a single endpoint definition, i.e. browse.
  3. Add routes for each endpoint to ghost/core/core/server/web/api/endpoints/admin/routes.js.
  4. Add basic e2e-api tests for the endpoint in ghost/core/test/e2e-api/admin to ensure the new endpoints function as expected.
  5. Run the tests and iterate until they pass: cd ghost/core && pnpm test:single test/e2e-api/admin/{test-file-name}.

Reference

For a detailed reference on Ghost's API framework and how to create API controllers, see [reference.md](reference.md).