zenpay-swagger-file
一套用于管理和增强API文档的完整工具包。
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：zenpay-swagger-file。 它的用途是：一套用于管理和增强API文档的完整工具包。 完整的 Skill 内容见：https://321skill.com/skills/zenpay-swagger-file/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“我需要为我们的支付API生成一份高质量的OpenAPI文档，并同步给前端团队。”，它会引导你使用`bun run getspec`获取最新API规范，然后运行`bun run analyze`检查当前文档质量，接着使用`bun run enhance --route payments`预览对核心支付接口的增强建议，确认无误后应用更改并生成TypeScript SDK，最后通过`bun run docs`启动一个交互式文档站点供团队查阅。
介绍
该工具包旨在解决API文档管理混乱、质量参差不齐的问题。它提供从自动下载、格式转换、质量分析到智能增强、SDK生成和交互式文档服务的一站式解决方案。用户可以通过简单的命令行操作，自动化完成API文档的获取、验证、分析和优化工作流。
它特别适合负责API设计、维护和开发者体验的工程师。无论是需要定期同步上游API规范，还是希望系统性地提升现有API文档的可读性和完整性，这个工具包都能提供标准化的流程和自动化工具。
对于后端开发、全栈开发以及文档工程师而言，这个工具能显著提升文档工作的效率和质量。它尤其适合在团队协作、对外提供API服务或进行API集成开发的场景中使用。
使用建议：建议从bun run analyze开始，了解当前文档的质量状况，然后针对评分较低或高优先级的路由（如sessions、payments）进行逐步增强。在应用任何增强前，务必使用bun run diff命令仔细审查变更内容。
核心特点
它不仅提供API规范的下载和验证，更核心的是集成了基于规则的文档质量自动分析与智能增强功能，能系统性地修复描述缺失、语言不规范等问题，并生成详细的改进报告。
注意事项
该工具主要针对OpenAPI/Swagger规范的文档进行增强，不适合处理非结构化或非API类的技术文档。
常见问题
这个工具能自动修复API文档中的所有问题吗？
不能，它主要基于预设规则（如API-STYLE-GUIDE.md）进行标准化增强，如补充描述、统一语言风格，但无法理解业务逻辑或生成全新的内容，需人工审核diff结果。
支持哪些API规范版本？
主要支持Swagger 2.0和OpenAPI 3.1，下载时会自动将Swagger 2.0转换为OpenAPI 3.1格式。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/zenpay-swagger-file/raw/index.md 读取 zenpay-swagger-file 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/zenpay-swagger-file/raw/index.md（查看排版版本）