mcpField
A
Add Admin API Endpoint

Add Admin API Endpoint

github.com/tryghost開発55.6k89 回インストール今日更新
リポジトリ

Add Admin API Endpoint について

Ghost の開発者向けに Admin API エンドポイントの追加手順を案内するスキルです。コントローラーやルートの変更、エンドツーエンド API テストを扱います。

主な機能

  1. 01エンドポイントファイルの作成・更新
  2. 02API コントローラーと browse エンドポイントの定義
  3. 03Admin API ルートの登録
  4. 04e2e-api テストの追加と実行

活用シーン

  1. 01Ghost の新しいリソースへのエンドポイント追加
  2. 02既存の Admin API エンドポイントの拡張

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tryghost/ghost --skill add-admin-api-endpoint

インストール後、Claude Code で/add-admin-api-endpointを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

permissions.md
reference.md
validation.md

詳細

管理 API エンドポイントの作成

手順

  1. まったく新しいリソースのエンドポイントを作成する場合は、ghost/core/server/api/endpoints/ に新しいエンドポイントファイルを作成します。それ以外の場合は、同じディレクトリにある既存のエンドポイントファイルを探します。
  2. エンドポイントファイルでは、(@tryghost/api-framework).Controller の JSDoc 型を使用してコントローラーオブジェクトを作成し、少なくとも docName と単一のエンドポイント定義（つまり browse）を含める必要があります。
  3. 各エンドポイントのルートを ghost/core/server/web/api/endpoints/admin/routes.js に追加します。
  4. 新しいエンドポイントが期待どおりに機能することを確認するために、ghost/test/e2e-api/admin にエンドポイントの基本的な e2e-api テストを追加します。
  5. テストを実行し、合格するまで繰り返します: cd ghost && pnpm test:single test/e2e-api/admin/{test-file-name}。

リファレンス

Ghost の API フレームワークの詳細なリファレンスと API コントローラーの作成方法については、reference.md を参照してください。

コメント

Markdown 対応