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. 02定义 API 控制器和 browse 端点
  3. 03注册 Admin API 路由
  4. 04添加并运行 e2e-api 测试

适用场景

  1. 01为 Ghost 新资源添加端点
  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

详细介绍

创建 Admin API 端点

说明

  1. 如果要为全新的资源创建端点，请在 ghost/core/server/api/endpoints/ 中新建一个端点文件。否则，请在同一目录中找到现有的端点文件。
  2. 端点文件应使用 (@tryghost/api-framework).Controller 中的 JSDoc 类型创建一个 controller 对象，至少包括一个 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 controller 的详细参考，请参阅 reference.md。

评论

支持 Markdown