OpenAPI 接口文档生成与核对

原名：openapi-spec-generation

把实现、请求样例和接口约定整理成可验证规范，检查文档与实际返回是否一致。

中文 Skills 技能说明

桌面端或合作方总因接口文档不完整而接入失败时，可让 API 测试工程师使用。提供脱敏路由、请求体、鉴权方式和真实响应，技能整理 OpenAPI 结构、错误码、字段与示例，交付规范草稿和契约检查清单。不能把示例当真实接口，必须区分必填字段、时区与成功失败结构；密钥只写占位符，不放进 URL。生成和验证需授权桌面工具，不会自动公开内部维护接口，发布文档和更改接口前由管理员复核兼容与权限。

上游能力依据

上游原始适用说明：Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

上游 SKILL.md 主要章节（保留原文标题）：

When to Use This Skill
Core Concepts
1. OpenAPI 3.1 Structure
2. Design Approaches
Templates and detailed worked examples
Best Practices
Do's
Don'ts

使用边界

先读取项目约定、依赖版本和现有测试，再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。

作者、翻译与许可证

原作者: Seth Hobson（wshobson）与 agents contributors
中文翻译: CEOFans翻译
许可证: MIT
上游来源: https://github.com/wshobson/agents/tree/46891e7e60da0e52baf1050b7b6391b64e84c6d9/plugins/documentation-generation/skills/openapi-spec-generation

适用范围

平台：linux、macos、windows；标签：软件开发、OpenAPI 接口文档生成与核对、开源技能

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。