SuperAPI AI 工具集

storyblok-best-practices

编程与开发

查看项目

更新于 10-15 20:05

技能介绍

用途:为使用 Storyblok CMS 的代理机构开发者提供系统化最佳实践,供 AI 代理与 LLM 在生成代码、设计内容模型时参考。

主要能力:包含 40 条规则、24 个类别,按影响优先级划分。关键类别包括内容建模(组件结构、字段配置、区块嵌套、命名规范)、SDK 集成(storyblokEditable()、组件全局注册、富文本自定义解析器)、可视化编辑器(Bridge 配置、草稿/已发布处理)、性能与缓存(Image Service 图片优化、cv 参数缓存失效、性能监控)、安全与认证(令牌管理、RBAC 权限)。高优先级类别涵盖字段插件(@storyblok/field-plugin)、API 开发(Content Delivery、GraphQL、Management API)、国际化(字段级与文件夹级翻译)、Next.js App Router/RSC、Nuxt 模块、App 开发、空间与资产管理、Webhook 自动化、发布工作流、CLI 与 DevOps、测试、富文本与媒体、常见模式(TypeScript 类型、错误处理、调试、关系引用)、SEO 结构化数据、电商集成、内容迁移、AI 功能、协作与自定义应用。

使用方式:按需阅读 rules/ 目录下的单条规则文件,如 rules/model-component-structure.md、rules/sdk-storyblok-editable.md、rules/editor-bridge-setup.md、rules/perf-image-optimization.md、rules/security-token-handling.md。每条规则含原因说明、错误与正确代码示例及配置参考表。

核心原则:可视化编辑器优先,组件须应用 storyblokEditable() 并配置 Bridge;区分 Content Delivery API(公开/预览令牌、CDN 缓存)、Management API(个人/OAuth 令牌、无缓存)与 GraphQL(只读、CDN);客户端不得暴露预览令牌、个人访问令牌与 OAuth 令牌,公开令牌仅用于读取已发布内容。

适用场景:设计内容模型与组件 schema、集成 React/Vue/Nuxt/Next.js、配置可视化编辑器与实时预览、开发字段插件、实现 API、设置 i18n、配置 Webhook、多空间架构与 CI/CD、富文本处理、图片优化、预览/生产环境搭建。

限制:资料未提供具体收费、价格、平台支持范围或效果数据;规则细节需查阅对应规则文件,本介绍不替代原文。