技能 编程开发 OpenAPI 规范生成

OpenAPI 规范生成

v20261119
openapi-spec-generation
从代码或设计优先的契约生成、维护并校验 OpenAPI 3.1 规范,适用于 API 文档编写、SDK 生成和接口契约合规检查。
获取技能
404 次下载
概览

OpenAPI Spec Generation

Comprehensive patterns for creating, maintaining, and validating OpenAPI 3.1 specifications for RESTful APIs.

Use this skill when

  • Creating API documentation from scratch
  • Generating OpenAPI specs from existing code
  • Designing API contracts (design-first approach)
  • Validating API implementations against specs
  • Generating client SDKs from specs
  • Setting up API documentation portals

Do not use this skill when

  • The task is unrelated to openapi spec generation
  • You need a different domain or tool outside this scope

Instructions

  • Clarify goals, constraints, and required inputs.
  • Apply relevant best practices and validate outcomes.
  • Provide actionable steps and verification.
  • If detailed examples are required, open resources/implementation-playbook.md.

Resources

  • resources/implementation-playbook.md for detailed patterns and examples.

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
信息
分类 编程开发
名称 openapi-spec-generation
版本 v20261119
大小 8.07KB
更新时间 2026-11-20
语言