| name | worma-guidelines |
| description | worma OpenAPI code generation and configuration. Use this skill whenever the user mentions worma config, API code generation, OpenAPI/Swagger integration, worma CLI, or migration from @alova/wormhole. Trigger for questions about worma.config, npx worma init/gen, or generating API code from OpenAPI specs. |
worma — Universal OpenAPI Code Generator
Pick the scenario that matches the user's need, then fetch the detailed information from the corresponding docs link before answering.
Scenario Guides
Predefined Templates
worma ships with request-library templates such as alova, axios, fetch, and ky. Use them in generator.plugins to control how API code is generated.
→ See Predefined Templates for usage, options, and examples.
Using the alova template? Install the alova skills for better client/server API usage guidance:
npx skills add https://github.com/alovajs/skills --skill alova-client-usage
npx skills add alovajs/skills --skill alova-server-usage
Predefined Plugins
Add these plugins to generator.plugins to customize the generation pipeline.
| Plugin | Description | Docs |
|---|
aiDoc() | Generates AI-readable interface docs for coding assistants. | aiDoc |
platform() | Auto-assembles OpenAPI URLs for Swagger, Knife4j, FastAPI, and YApi. | platform |
apifox() | Imports OpenAPI documents directly from Apifox. | apifox |
rename() | Renames/transforms API URLs and parameters. | rename |
tagModifier() | Modifies the tags of APIs in the OpenAPI spec. | tagModifier |
payloadModifier() | Adds, removes, or changes request/response parameter types. | payloadModifier |
filterApi() | Filters APIs by URL or tag with matching rules. | filterApi |
importType() | Reuses external types and excludes auto-generated types. | importType |
→ See Built-in Plugins Overview for shared usage patterns and more details.
