关于 worma-guidelines
worma-guidelines 是 worma（OpenAPI 代码生成器）的参考技能，帮助开发者按场景查找配置、迁移、命令行和插件等文档。
主要功能
- 01按场景查找文档
- 02提供 axios、ky 和 wormhole 迁移指南
- 03涵盖命令行、模板和插件
- 04介绍内置模板与插件
适用场景
- 01查找 worma 项目的初始配置
- 02规划从 axios 或 ky 迁移
- 03了解如何添加自定义插件
- 04查询 API 代码生成选项
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/worma-guidelines确认已加载。
附带文件README.mdreferences/migration-wormhole.md
详细介绍
worma — 通用 OpenAPI 代码生成器
选择符合用户需求的场景，然后在回答前从对应的文档链接获取详细信息。
如果本文档中没有找到具体指南，请查阅 worma 文档索引 https://worma.js.org/llms.txt，找到相关指南。
迁移触发短语
遇到以下问题时，请使用此技能：
- 从 @alova/wormhole 迁移到 worma
- 从 axios 迁移到 worma
- 从 ky 迁移到 worma
- 从 wormhole/axios/ky 切换到 worma
场景指南
| 场景 | 文档链接 |
|---|---|
| 首次设置／安装与配置 | 安装与配置 |
| 快速入门 | 快速入门 |
从 axios 迁移 | 从 Axios 迁移 |
从 ky 迁移 | 从 Ky 迁移 |
CLI 命令（init、gen 等） | CLI 命令 |
| 编写自定义 Handlebars 模板 | 自定义模板 |
| 构建自己的插件 | 自定义插件 / 插件 API |
| 编程式 API | 核心函数 / 配置 API |
| 生成 AI 技能文档 | AI 技能 |
| VSCode 扩展 | 编辑器文档 |
| Monorepo 设置 | Monorepo |
| 性能调优 | 性能 |
从 @alova/wormhole 迁移到 worma 的工作流
→ references/migration-wormhole.md
预定义模板
worma 内置了 alova、axios、fetch 和 ky 等请求库模板。在 generator.plugins 中使用这些模板，可以控制 API 代码的生成方式。
→ 有关用法、选项和示例，请参阅预定义模板。
使用 alova 模板？ 安装 alova skills，获取更好的客户端/服务端 API 使用指导：
npx skills add https://github.com/alovajs/skills --skill alova-client-usage npx skills add alovajs/skills --skill alova-server-usage
预定义插件
将这些插件添加到 generator.plugins，以自定义生成流程。
| 插件 | 描述 | 文档 |
|---|---|---|
aiDoc() | 为编码助手生成便于 AI 阅读的接口文档。 | aiDoc |
platform() | 自动组装 Swagger、Knife4j、FastAPI 和 YApi 的 OpenAPI URL。 | platform |
apifox() | 直接从 Apifox 导入 OpenAPI 文档。 | apifox |
rename() | 重命名/转换 API URL 和参数。 | rename |
tagModifier() | 修改 OpenAPI 规范中 API 的 tags。 | tagModifier |
payloadModifier() | 添加、移除或更改请求/响应参数类型。 | payloadModifier |
filterApi() | 根据匹配规则，按 URL 或标签筛选 API。 | filterApi |
importType() | 复用外部类型，并排除自动生成的类型。 | importType |
→ 有关通用用法模式和更多详情，请参阅内置插件概览。
评论
支持 Markdown