用途:在 Ghost 的 Admin API(路径 ghost/api/admin/**)中新增端点。若面向全新资源,需在 ghost/core/server/api/endpoints/ 下新建端点文件;否则定位同目录下已有端点文件进行修改。
主要能力与步骤:端点文件需使用 @tryghost/api-framework 的 Controller JSDoc 类型创建 controller 对象,至少包含 docName 和一个端点定义(如 browse)。随后在 ghost/core/server/web/api/endpoints/admin/routes.js 中为每个端点添加路由。还需在 ghost/test/e2e-api/admin 下为新端点编写基础 e2e-api 测试,确保其按预期工作。
使用方式:运行测试并迭代直至通过,命令为 cd ghost && pnpm test:single test/e2e-api/admin/{test-file-name}。关于 Ghost API 框架与创建 API controller 的详细参考,见 reference.md。
适用场景:适用于需要扩展 Ghost Admin API 功能的开发任务。限制:资料未提供更多关于权限、错误处理或版本兼容性的说明。