# worma Docs

> OpenAPI-based code and knowledge generation, from humans to AI

- [Introduction](/llms.mdx/docs/index.md): worma  -  One OpenAPI spec, generating both API code and AI knowledge
- [Quick Start](/llms.mdx/docs/quick-start.md): Generate your first API and try VSCode hover docs in 5 minutes
- [CLI Commands](/llms.mdx/docs/cli-commands.md): Detailed parameters for worma init / gen / diff
- [Performance](/llms.mdx/docs/performance.md): worma's performance optimization design for large-scale OpenAPI generation
- [Contributing](/llms.mdx/docs/contributing.md): Welcome to worma's development and docs — start your first contribution here
- [Contributors](/llms.mdx/docs/contributors.md): Thanks to everyone who contributed during worma's beta phase
- [Sponsor](/llms.mdx/docs/sponsor.md): Support worma's continued growth and help open source go further
- Guide
  - [Installation & Configuration](/llms.mdx/docs/guide/installation-config.md): CLI install, init, and worma.config.js configuration
  - [Monorepo Support](/llms.mdx/docs/guide/monorepo.md): Auto-detect sub-packages in a Monorepo and generate API code
  - [In-Editor Docs](/llms.mdx/docs/guide/editor-docs.md): VSCode extension — hover for API details, sidebar API explorer
- Plugin System
  - [Plugin System](/llms.mdx/docs/plugin-system.md): The plugin system's 8 lifecycle hooks and progress reporting
  - Built-in Plugins
    - [Built-in Plugins](/llms.mdx/docs/plugin-system/builtin-plugins.md): Usage of all built-in plugins, including importType, aiDoc, swagger/knife4j/yapi/apifox, rename, tagModifier, and more
    - [AI Doc Generator](/llms.mdx/docs/plugin-system/builtin-plugins/aiDoc.md): Generate AI-readable API knowledge docs so coding agents understand your project's APIs precisely
    - [Platform Fetchers](/llms.mdx/docs/plugin-system/builtin-plugins/platform.md): Auto-build the OpenAPI file URL for Swagger / Knife4j / YApi / Apifox / Postman
    - [Rename Plugin](/llms.mdx/docs/plugin-system/builtin-plugins/rename.md): Rename API URLs and parameters, with multiple naming styles and custom rules
    - [Tag Modifier](/llms.mdx/docs/plugin-system/builtin-plugins/tag-modifier.md): Modify the tags of APIs from the OpenAPI document
    - [Payload Modifier](/llms.mdx/docs/plugin-system/builtin-plugins/payload-modifier.md): Flexibly modify an API's request and response parameters — add, remove, or change field types, with tag/path filtering and response unwrapping
    - [API Filter](/llms.mdx/docs/plugin-system/builtin-plugins/filter-api.md): Filter API endpoints by URL or tag, with multiple match rules and combined conditions
    - [Type Replacer](/llms.mdx/docs/plugin-system/builtin-plugins/import-type.md): Reuse external types, exclude them from auto-generation, support import type
  - [Custom Plugins](/llms.mdx/docs/plugin-system/custom-plugin.md): A complete guide to developing custom plugins
  - [Example: Plugins that Rename Functions / Response Types](/llms.mdx/docs/plugin-system/examples.md): Learn plugin development through real examples
- Template System
  - [Template System](/llms.mdx/docs/template-system.md): Understand the overall architecture of the template system
  - [Predefined Templates](/llms.mdx/docs/template-system/predefined-templates.md): Use the five built-in predefined templates
  - [Custom Templates](/llms.mdx/docs/template-system/custom-templates.md): Create custom code-generation templates with Handlebars
- AI Skills
  - [AI Skills Integration](/llms.mdx/docs/ai-skills.md): Let AI tools understand your API endpoints precisely
  - [Skill Doc Structure](/llms.mdx/docs/ai-skills/skill-structure.md): Detailed format of SKILL.md and references/*.md
- API Reference
  - [Core Functions](/llms.mdx/docs/api/core-functions.md): Programmatic APIs like defineConfig, generate, and readConfig
  - [Configuration Object](/llms.mdx/docs/api/configuration.md): The complete types for defineConfig and GeneratorConfig
  - [Plugin API](/llms.mdx/docs/api/plugin-api.md): The ApiPlugin interface and lifecycle hooks
- Migration
  - [Migrate from Axios](/llms.mdx/docs/migration/from-axios.md): Move from hand-written axios calls to worma's type-safe generated calls
  - [Migrate from Ky](/llms.mdx/docs/migration/from-ky.md): Move from hand-written ky calls to worma's type-safe generated calls
  - [Migrate from wormhole](/llms.mdx/docs/migration/from-wormhole.md): A complete guide to migrating from @alova/wormhole to worma

# Docs

- [介绍](/llms.mdx/docs/zh/index.md): worma — 一份 OpenAPI，同时生成调用代码和 AI 知识
- [快速开始](/llms.mdx/docs/zh/quick-start.md): 5 分钟生成并体验 VSCode 悬停文档

- **Separator**
- 指南
  - [安装与配置](/llms.mdx/docs/zh/guide/installation-config.md): CLI 安装、init、worma.config.js 配置详解
  - [Monorepo 支持](/llms.mdx/docs/zh/guide/monorepo.md): 在 Monorepo 项目中自动识别子包并生成 API 代码
  - [编辑器内文档](/llms.mdx/docs/zh/guide/editor-docs.md): VSCode 扩展：悬停查看 API 详情、侧边栏 API 浏览器
- 插件系统
  - [插件系统](/llms.mdx/docs/zh/plugin-system.md): 插件系统的 8 个生命周期 hook 和进度报告
  - 内置插件
    - [内置插件](/llms.mdx/docs/zh/plugin-system/builtin-plugins.md): 全部内置插件的使用，包括 importType、aiDoc、swagger/knife4j/yapi/apifox、rename、tagModifier 等
    - [AI 文档生成器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/aiDoc.md): 生成 AI 可读的接口知识文档，让编码助手准确感知项目 API
    - [平台拉取器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/platform.md): 自动拼接 Swagger / Knife4j / YApi / Apifox / Postman 的 OpenAPI 文件地址
    - [重命名插件](/llms.mdx/docs/zh/plugin-system/builtin-plugins/rename.md): 对 API 接口的 URL 和参数进行重命名转换，支持多种命名风格和自定义转换规则
    - [tag 修改器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/tag-modifier.md): 修改 OpenAPI 文件中 API 的 tags
    - [参数修改器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/payload-modifier.md): 灵活修改 API 接口的请求和响应参数，支持增加、删除、修改参数类型，支持按 tag/path 过滤与响应解包
    - [API 过滤器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/filter-api.md): 根据 URL 或标签（tag）过滤 API 接口，支持多种匹配规则和组合条件
    - [类型替换器](/llms.mdx/docs/zh/plugin-system/builtin-plugins/import-type.md): 复用外部类型，排除自动生成，支持 import type
  - [自定义插件](/llms.mdx/docs/zh/plugin-system/custom-plugin.md): 开发自定义插件的完整指南
  - [示例：修改函数名/响应类型的插件](/llms.mdx/docs/zh/plugin-system/examples.md): 通过实际示例学习插件开发
- 模板系统
  - [模板系统](/llms.mdx/docs/zh/template-system.md): 了解模板系统的整体架构
  - [预定义模板](/llms.mdx/docs/zh/template-system/predefined-templates.md): 使用内置的五套预定义模板
  - [自定义模板](/llms.mdx/docs/zh/template-system/custom-templates.md): 使用 Handlebars 创建自定义代码生成模板
- AI Skills
  - [AI Skills 集成](/llms.mdx/docs/zh/ai-skills.md): 让 AI 工具精准理解你的 API 接口
  - [Skill 文档结构](/llms.mdx/docs/zh/ai-skills/skill-structure.md): SKILL.md 主文档和 references/*.md 的详细格式
- [CLI 命令](/llms.mdx/docs/zh/cli-commands.md): worma init / gen / diff 命令参数详解

- **Separator**
- API 参考
  - [核心函数](/llms.mdx/docs/zh/api/core-functions.md): defineConfig、generate、readConfig 等编程 API
  - [配置对象](/llms.mdx/docs/zh/api/configuration.md): defineConfig 和 GeneratorConfig 的完整类型
  - [插件 API](/llms.mdx/docs/zh/api/plugin-api.md): ApiPlugin 接口与生命周期钩子
- [性能](/llms.mdx/docs/zh/performance.md): worma 针对大规模 OpenAPI 生成的性能优化设计
- 迁移指南
  - [从 Axios 迁移](/llms.mdx/docs/zh/migration/from-axios.md): 从手动调用 axios 迁移到 worma 生成的类型安全调用代码
  - [从 Ky 迁移](/llms.mdx/docs/zh/migration/from-ky.md): 从手动调用 ky 迁移到 worma 生成的类型安全调用代码
  - [从 wormhole 迁移](/llms.mdx/docs/zh/migration/from-wormhole.md): @alova/wormhole 迁移到 worma 的完整指南

- **Separator**
- [赞助](/llms.mdx/docs/zh/sponsor.md): 支持 worma 持续发展，让开源项目走得更远
- [贡献指南](/llms.mdx/docs/zh/contributing.md): 欢迎参与 worma 的开发与文档建设，从这里开始你的第一次贡献
- [贡献者](/llms.mdx/docs/zh/contributors.md): 感谢每一位参与 worma beta 阶段的贡献者