mcpField
O
openapi-spec-generation

openapi-spec-generation

github.com/sickn33开发49.2k219 次安装1 天前更新
代码仓库

关于 openapi-spec-generation

用于创建、维护和验证 REST API 的 OpenAPI 3.1 规范，适合从 API 设计到实现验证和文档编写的开发工作。

主要功能

  1. 01创建 OpenAPI 规范
  2. 02从现有代码生成规范
  3. 03设计 API 契约
  4. 04按规范验证实现
  5. 05生成客户端 SDK

适用场景

  1. 01从头编写 REST API 文档
  2. 02根据现有代码生成规范
  3. 03核对 API 实现是否符合契约
  4. 04根据规范生成客户端 SDK

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill openapi-spec-generation

安装后在 Claude Code 中输入/openapi-spec-generation确认已加载。

附带文件resources/implementation-playbook.md

详细介绍

OpenAPI 规范生成

用于为 RESTful API 创建、维护和验证 OpenAPI 3.1 规范的全面模式。

何时使用此技能

  • 从零开始创建 API 文档
  • 从现有代码生成 OpenAPI 规范
  • 设计 API 契约（设计优先方法）
  • 根据规范验证 API 实现
  • 从规范生成客户端 SDK
  • 搭建 API 文档门户

何时不要使用此技能

  • 任务与 openapi 规范生成无关
  • 你需要此范围之外的其它领域或工具

说明

  • 明确目标、约束和所需输入。
  • 应用相关最佳实践并验证结果。
  • 提供可执行的步骤和验证方法。
  • 如果需要详细示例，请打开 resources/implementation-playbook.md。

资源

  • resources/implementation-playbook.md，其中包含详细的模式和示例。

限制

  • 仅当任务明确符合上述范围时使用此技能。
  • 不要将输出视为特定环境验证、测试或专家评审的替代品。
  • 如果缺少所需输入、权限、安全边界或成功标准，请停止并请求澄清。

评论

支持 Markdown