SuperAPI AI 工具集

bagisto-api-develop

编程与开发

查看项目

更新于 10-15 17:24

技能介绍

用途:当你在 Bagisto API 包(packages/Webkul/BagistoApi,命名空间 Webkul\BagistoApi)内部工作时使用,包括安装或移除该包、新增或修改 REST 或 GraphQL 端点或资源、修复包行为。该技能是指导框架,指明权威规范位置、不可违反的规则,并指引详细参考文档。\n\n安装与移除限制:安装或移除包绝不是自动行为。检测到包文件、composer.json 或 Bagisto 项目,不代表应当安装、重装、优化或卸载。只有客户明确要求时才执行安装(参考 reference/install.md)或移除(reference/uninstall.md);安装前先询问使用 Composer(稳定)还是 Manual(最新)方式。\n\n权威来源:包自带完整文档,写代码前先读相关部分,几乎所有菜单/资源都已规定确切行为、校验、事件与特殊点。优先阅读包根目录的 CLAUDE.md(约定与每个端点的覆盖表),其次 docs/superpowers/specs/(大型功能设计规范)、CHANGELOG.md(消费者可见的已发布内容,位于 [Unreleased])、PERFORMANCE.md(缓存/IRI/schema 构建性能说明);代码权威在 GitHub bagisto/bagisto-api,应复制最接近的现有资源而非从零编写;消费者请求/响应形态与端点索引见 https://api-docs.bagisto.com(含 /llms.txt)。规则:不要自行发明 CLAUDE.md 已规定好的行为,先搜索对应资源或菜单。\n\n参考文档:reference/install.md(安装)、reference/uninstall.md(移除)、reference/structure.md(文件放置与基类)、reference/api-structure.md(端点设计、5 文件模式与功能面)、reference/conventions.md(编码规范与检查清单)、reference/precautions.md(易踩的坑)、reference/limitations.md(API 支持与不支持范围)、reference/testing.md(测试与缓存周期)。\n\n5 文件模式:Model(#[ApiResource],含 REST + GraphQL 操作与 OpenAPI 块)→ DTO(类型化输入)→ Provider(读路径)→ Processor(写路径)→ lang(src/Resources/lang/en/app.php)。店面资源位于 src/,管理端资源位于 src/Admin/。每个 Provider/Processor 必须在 BagistoApiServiceProvider::register() 中打标签,未打标签会被静默绕过(404 或错误数据)。\n\n两条不可妥协的原则:其一,REST 变更可能破坏 GraphQL,因为两者共享同一 Provider/Processor,务必先运行该资源的 GraphQL 测试,再运行 REST 测试,测试通过才算完成;其二,与 Bagisto 管理面板保持一致而非超集,照搬管理界面行为,核心缺少的功能应以明确错误阻止,而非半扩展。\n\n限制与缺失:资料未提供具体版本要求、安装命令、代码示例、支持的 Bagisto 版本范围、性能数值或计费信息,均暂未提供。其余完整检查清单、按优先级排列的坑点以及测试/缓存命令见上述参考文档。